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:):
- For registered users:
POST /contacts/uem:[email protected]/notes - For leads:
POST /contacts/lem:[email protected]/notes - You must know whether it's a user or lead
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 notenote: The note contentcreated_at: Unix timestamp when the note was createdcreated_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"
}| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
401Authentication credentials are missing or invalid. Please check your API key.
403You don't have permission to add notes to contacts. Check your account permissions.
404Contact not found. The identifier doesn't match any contact in your account.
422Validation error. The 'note' field is required and cannot be empty.