Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
chats
/
{phone}
/
notes
Assign notes to a chat
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/chats/{phone}/notes \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "notes": "<string>"
}
'

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Through this method, you can assign notes to a chat on WhatsApp Business.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Path

​
phone
string
required
Chat phone number

​
Required

​
notes
string
required
Note text

​
Request Body

{
  "notes": "annotation"
}

​
Response

​
200

{
  "success": true
}

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

​
415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.