Add a note to a contact

Creates a new internal note for a specific contact. Notes are useful for tracking
important information, context, or reminders about contacts that your team needs to remember.

How to Identify a Contact

Use any of these identifier formats in the URL path:

1. Customerly Contact ID (numeric):

  • Example: POST /contacts/29911301/notes
  • The internal numeric ID from Customerly

2. Custom User ID (prefix: cuid:):

  • Example: POST /contacts/cuid:user_123/notes
  • Your own custom identifier for a registered user

3. Custom Lead ID (prefix: clid:):

  • Example: POST /contacts/clid:lead_456/notes
  • Your own custom identifier for a lead

4. WhatsApp Number (prefix: wa:):

  • Example: POST /contacts/wa:+1234567890/notes
  • Must include country code with + prefix (E.164 format)

5. Email Address (prefix: uem: or lem:):

Request Body

Send a JSON object with the note field containing the note content.

Response

Returns HTTP 201 (Created) with the created note object including:

  • contact_note_id: The ID of the newly created note
  • note: The note content
  • created_at: Unix timestamp when the note was created
  • created_by: ID of the account that created the note

Example Requests

POST /contacts/29911301/notes
{
  "note": "Customer requested callback on Monday at 10 AM"
}

POST /contacts/cuid:user_abc123/notes
{
  "note": "VIP customer - handle with priority"
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Contact identifier. Can be: numeric ID (e.g., '12345'), custom user ID with 'cuid:' prefix (e.g., 'cuid:user_123'), custom lead ID with 'clid:' prefix (e.g., 'clid:lead_456'), WhatsApp with 'wa:' prefix (e.g., 'wa:+1234567890'), or email with 'uem:' or 'lem:' prefix (e.g., 'uem:[email protected]' for users or 'lem:[email protected]' for leads).

Body Params
string
required

The content of the note. Can contain any text.

Responses

401

Authentication credentials are missing or invalid. Please check your API key.

403

You don't have permission to add notes to contacts. Check your account permissions.

404

Contact not found. The identifier doesn't match any contact in your account.

422

Validation error. The 'note' field is required and cannot be empty.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json