CLclose
activities.notes

Create a Note activity

Changed on

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

  • Base URL
    https://api.close.com/api/v1
  • URL
    https://api.close.com/api/v1/activity/note/
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://app.close.com/oauth2/authorize/
      Token URL: https://api.close.com/oauth2/token/

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
agent_action_reasonstring nullable
agent_config_idstring nullable

Deprecated. Use created_by_agent_id instead.

contact_idstring nullable required
created_bystring nullable required
created_by_agent_idstring nullable
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_agent_idstring nullable
updated_by_namestring nullable
user_idstring nullable required
user_namestring nullable
usersstring[] required

Changes

  • 784846be4a00Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 2ff98656cc2aRevision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status