Create a Note activity | Close | Developer API Documentation

curl -X POST https://api.close.com/api/v1/activity/note/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "lead_id": "lead_s6vHFTK1TSRoH6otXOexWDO9jM4xyb1kELHDoU7Fdsp",
  "attachments": [
    {
      "filename": "picture.gif",
      "url": "https://app.close.com/go/file/temporary/user_MvDoAZA889UMrgsZbnXmHkJSomSi7qk2Iwc4JnGHTbo/3HV4BNwDyBLdfrPbFZF78s/picture.gif/",
      "content_type": "image/gif"
    }
  ],
  "note_html": "<body><p>this is a test note.</p></body>"
}'

{
  "_type": "Note",
  "activity_at": "2013-02-20T06:39:57.266000+00:00",
  "contact_id": null,
  "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "date_created": "2013-02-20T06:39:57.266000+00:00",
  "date_updated": "2013-02-20T06:39:57.266000+00:00",
  "id": "acti_kwWA3rOfy4BnaZ8QQk3RIIAz51dU9ayiluy1s961Oiw",
  "lead_id": "lead_s6vHFTK1TSRoH6otXOexWDO9jM4xyb1kELHDoU7Fdsp",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "users": [],
  "created_by_name": "Bruce Wayne",
  "updated_by_name": "Bruce Wayne",
  "user_name": "Bruce Wayne",
  "attachments": [
    {
      "content_type": "image/gif",
      "filename": "picture.gif",
      "size": 20673,
      "thumbnail_url": "https://app.close.com/go/file/persisted/orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH/activity.note/acti_kwWA3rOfy4BnaZ8QQk3RIIAz51dU9ayiluy1s961Oiw/3HV4BNwDyBLdfrPbFZF78s/picture.gif/thumbnail/",
      "url": "https://app.close.com/go/file/persisted/orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH/activity.note/acti_kwWA3rOfy4BnaZ8QQk3RIIAz51dU9ayiluy1s961Oiw/3HV4BNwDyBLdfrPbFZF78s/picture.gif/"
    }
  ],
  "note": "this is a test note.",
  "note_html": "<body><p>this is a test note.</p></body>",
  "pinned": false,
  "pinned_at": null,
  "title": null
}

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/`. A note can be pinned or unpinned by setting the `pinned` field to `true` or `false` when creating or updating a note.

curl -X POST https://api.close.com/api/v1/activity/note/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "lead_id": "lead_s6vHFTK1TSRoH6otXOexWDO9jM4xyb1kELHDoU7Fdsp",
  "attachments": [
    {
      "filename": "picture.gif",
      "url": "https://app.close.com/go/file/temporary/user_MvDoAZA889UMrgsZbnXmHkJSomSi7qk2Iwc4JnGHTbo/3HV4BNwDyBLdfrPbFZF78s/picture.gif/",
      "content_type": "image/gif"
    }
  ],
  "note_html": "<body><p>this is a test note.</p></body>"
}'

{
  "_type": "Note",
  "activity_at": "2013-02-20T06:39:57.266000+00:00",
  "contact_id": null,
  "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "date_created": "2013-02-20T06:39:57.266000+00:00",
  "date_updated": "2013-02-20T06:39:57.266000+00:00",
  "id": "acti_kwWA3rOfy4BnaZ8QQk3RIIAz51dU9ayiluy1s961Oiw",
  "lead_id": "lead_s6vHFTK1TSRoH6otXOexWDO9jM4xyb1kELHDoU7Fdsp",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "users": [],
  "created_by_name": "Bruce Wayne",
  "updated_by_name": "Bruce Wayne",
  "user_name": "Bruce Wayne",
  "attachments": [
    {
      "content_type": "image/gif",
      "filename": "picture.gif",
      "size": 20673,
      "thumbnail_url": "https://app.close.com/go/file/persisted/orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH/activity.note/acti_kwWA3rOfy4BnaZ8QQk3RIIAz51dU9ayiluy1s961Oiw/3HV4BNwDyBLdfrPbFZF78s/picture.gif/thumbnail/",
      "url": "https://app.close.com/go/file/persisted/orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH/activity.note/acti_kwWA3rOfy4BnaZ8QQk3RIIAz51dU9ayiluy1s961Oiw/3HV4BNwDyBLdfrPbFZF78s/picture.gif/"
    }
  ],
  "note": "this is a test note.",
  "note_html": "<body><p>this is a test note.</p></body>",
  "pinned": false,
  "pinned_at": null,
  "title": null
}

To include an attachment, you must first upload the file to Close using the Files API. 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. It must begin https://app.close.com/go/file/.

A note can be pinned or unpinned by setting the pinned field to true or false when creating or updating a note.

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

lead_idstringRequired

activity_atdatetime or nullOptional

attachmentslist of objects or nullOptional

contact_idstring or nullOptional

created_bystring or nullOptional

date_createddatetime or nullOptional

notestring or nullOptional

note_htmlstring or nullOptional

organization_idstring or nullOptional

pinnedboolean or nullOptional

titlestring or nullOptional

user_idstring or nullOptional

Response

Successful response

_typestring

activity_atdatetime or null

contact_idstring or null

created_bystring or null

date_createddatetime

date_updateddatetime

idstring

lead_idstring or null

organization_idstring

updated_bystring or null

user_idstring or null

userslist of strings

created_by_namestring or null

updated_by_namestring or null

user_namestring or null

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

$	curl -X POST https://api.close.com/api/v1/activity/note/ \
>	-H "Content-Type: application/json" \
>	-u "<CLOSE_API_KEY>:" \
>	-d '{
>	"lead_id": "lead_s6vHFTK1TSRoH6otXOexWDO9jM4xyb1kELHDoU7Fdsp",
>	"attachments": [
>	{
>	"filename": "picture.gif",
>	"url": "https://app.close.com/go/file/temporary/user_MvDoAZA889UMrgsZbnXmHkJSomSi7qk2Iwc4JnGHTbo/3HV4BNwDyBLdfrPbFZF78s/picture.gif/",
>	"content_type": "image/gif"
>	}
>	],
>	"note_html": "<body><p>this is a test note.</p></body>"
>	}'

1	{
2	"_type": "Note",
3	"activity_at": "2013-02-20T06:39:57.266000+00:00",
4	"contact_id": null,
5	"created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
6	"date_created": "2013-02-20T06:39:57.266000+00:00",
7	"date_updated": "2013-02-20T06:39:57.266000+00:00",
8	"id": "acti_kwWA3rOfy4BnaZ8QQk3RIIAz51dU9ayiluy1s961Oiw",
9	"lead_id": "lead_s6vHFTK1TSRoH6otXOexWDO9jM4xyb1kELHDoU7Fdsp",
10	"organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
11	"updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
12	"user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
13	"users": [],
14	"created_by_name": "Bruce Wayne",
15	"updated_by_name": "Bruce Wayne",
16	"user_name": "Bruce Wayne",
17	"attachments": [
18	{
19	"content_type": "image/gif",
20	"filename": "picture.gif",
21	"size": 20673,
22	"thumbnail_url": "https://app.close.com/go/file/persisted/orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH/activity.note/acti_kwWA3rOfy4BnaZ8QQk3RIIAz51dU9ayiluy1s961Oiw/3HV4BNwDyBLdfrPbFZF78s/picture.gif/thumbnail/",
23	"url": "https://app.close.com/go/file/persisted/orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH/activity.note/acti_kwWA3rOfy4BnaZ8QQk3RIIAz51dU9ayiluy1s961Oiw/3HV4BNwDyBLdfrPbFZF78s/picture.gif/"
24	}
25	],
26	"note": "this is a test note.",
27	"note_html": "<body><p>this is a test note.</p></body>",
28	"pinned": false,
29	"pinned_at": null,
30	"title": null
31	}