Sign in
latestOpenAPI 3.1.02026-08-233001841.3 MB

0dcf3303e9d7

activities.notes

Create a Note activity

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.

post/activity/note/

Request body

activity_atstring date-time nullable
contact_idstring nullable
created_bystring nullable
date_createdstring date-time nullable
lead_idstring required
notestring nullable
note_htmlstring nullable
organization_idstring nullable
pinnedboolean nullable
titlestring nullable
user_idstring nullable

Response

Successful response

_typestring required
activity_atstring date-time nullable required
contact_idstring nullable required
created_bystring nullable required
created_by_namestring nullable
date_createdstring date-time required
date_updatedstring date-time required
idstring required
lead_idstring nullable required
notestring required
note_htmlstring required
note_mentionsstring[] required
organization_idstring required
pinnedboolean required
pinned_atstring date-time nullable required
source'ui' | 'api' | 'import' | 'clipper' | 'email' | 'suggestion' | 'segment-integration' | 'customerio-integration' | 'calendly-integration' | 'ai' | 'whatsapp' | 'webform' required
titlestring nullable required
updated_bystring nullable required
updated_by_namestring nullable
user_idstring nullable required
user_namestring nullable
usersstring[] required