{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Endpoints subpackage_activities subpackage_activitiesNotes API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "subpackage_activitiesNotes",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List or filter all Note activities",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.close.com/api/v1/activity/note/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "_limit",
                "value": "",
                "type": "query",
                "description": "Number of results to return."
              },
              {
                "name": "_skip",
                "value": "",
                "type": "query",
                "description": "Number of results to skip before returning, for pagination."
              },
              {
                "name": "id__in",
                "value": "",
                "type": "query",
                "description": "Filter by activity IDs (comma-separated)"
              },
              {
                "name": "lead_id",
                "value": "",
                "type": "query",
                "description": "Filter by lead IDs (comma-separated)"
              },
              {
                "name": "contact_id",
                "value": "",
                "type": "query",
                "description": "Filter by contact IDs (comma-separated)"
              },
              {
                "name": "user_id",
                "value": "",
                "type": "query",
                "description": "Filter by user IDs (comma-separated)"
              },
              {
                "name": "organization_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "_type",
                "value": "",
                "type": "query",
                "description": "Filter by activity type, e.g. Call (comma-separated)"
              },
              {
                "name": "date_created__gte",
                "value": "",
                "type": "query"
              },
              {
                "name": "date_created__lte",
                "value": "",
                "type": "query"
              },
              {
                "name": "date_created__gt",
                "value": "",
                "type": "query"
              },
              {
                "name": "date_created__lt",
                "value": "",
                "type": "query"
              },
              {
                "name": "activity_at__gte",
                "value": "",
                "type": "query"
              },
              {
                "name": "activity_at__lte",
                "value": "",
                "type": "query"
              },
              {
                "name": "activity_at__gt",
                "value": "",
                "type": "query"
              },
              {
                "name": "activity_at__lt",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "List or filter all Note activities"
        },
        {
          "info": {
            "name": "Create a Note activity",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.close.com/api/v1/activity/note/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "To include an attachment, you must first upload the file to Close using the [Files API](https://developer.close.com/api/resources/files). Then, add an object to the `attachments` array with the following fields: `url`, `filename` and `content_type`. The `url` should be the URL provided in the `download.url` field of the response from the [Files API](https://developer.close.com/api/resources/files). It must begin `https://app.close.com/go/file/`.\n\nA note can be pinned or unpinned by setting the `"
        },
        {
          "info": {
            "name": "Get a single Note activity",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.close.com/api/v1/activity/note/:id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get a single Note activity"
        },
        {
          "info": {
            "name": "Update a Note activity",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.close.com/api/v1/activity/note/:id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "**`note_html` and `note`**: setting one overwrites the other. If both are provided, `note_html` takes precedence. `note_html` supports rich-text HTML; `note` is plaintext only.\n\nA note can be pinned or unpinned by setting `pinned` to `true` or `false`."
        },
        {
          "info": {
            "name": "Delete a Note activity",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.close.com/api/v1/activity/note/:id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Delete a Note activity"
        }
      ]
    }
  ],
  "bundled": true
}