CLclose
activities.notes

Update a Note activity

Changed on

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.

A note can be pinned or unpinned by setting pinned to true or false.

put/activity/note/{id}/

Request

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

Path parameters

idstring required

Request body

activity_atstring date-time nullable
contact_idstring nullable
notestring nullable
note_htmlstring nullable
pinnedboolean nullable
titlestring 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 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