Create conversation note
Adds a line with date and time to the internal note of the contact of this conversation; the old text stays and the contact never sees the note. Needs an Idempotency-Key header.
POST /v1/conversations/{conversation_id}/notes
| Permission | inbox:write and contacts:write (all permissions) |
| Risk | Write (no outside effect) |
| Idempotency-Key | Required (how it works) |
| Safe to repeat | Safe to repeat with the same Idempotency-Key: the first answer comes back and nothing is done twice. |
| Rate limit class | write (120 requests per minute per key) |
| Confirmation | None |
| MCP tool | add_conversation_note |
| Since version | 2026-10-25 |
#What it does
- Changes data in your account. It does not send messages to contacts.
- May start automations of the account, and an automation may send messages. The call itself sends nothing.
- Safe to repeat with the same Idempotency-Key.
#Request
Header
| Name | Required | Description |
|---|---|---|
Authorization | yes | Bearer <key> |
Idempotency-Key | yes | A unique value for this operation, for example a UUID (1 to 255 visible ASCII characters). |
Path parameters
| Name | Type | Description |
|---|---|---|
conversation_id | string | Conversation ID from list_conversations. |
Body (JSON)
| Name | Type | Required | Description |
|---|---|---|---|
text | string | yes | The note text. length 1 to 5000 |
#Examples
curl -X POST "https://api.smartchat.marketing/v1/conversations/cnv_1a2b3c4d5e6f47a8b9c0d1e2f3a4b5c6/notes" \
-H "Authorization: Bearer $SMARTCHAT_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"text": "Prefers a table by the window."
}'import os
import uuid
import requests
response = requests.post(
"https://api.smartchat.marketing/v1/conversations/cnv_1a2b3c4d5e6f47a8b9c0d1e2f3a4b5c6/notes",
headers={
"Authorization": "Bearer " + os.environ["SMARTCHAT_API_KEY"],
"Idempotency-Key": str(uuid.uuid4()),
},
json={
"text": "Prefers a table by the window.",
},
)
response.raise_for_status()
print(response.json())const response = await fetch("https://api.smartchat.marketing/v1/conversations/cnv_1a2b3c4d5e6f47a8b9c0d1e2f3a4b5c6/notes", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.SMARTCHAT_API_KEY}`,
"Idempotency-Key": crypto.randomUUID(),
"Content-Type": "application/json",
},
body: JSON.stringify({
"text": "Prefers a table by the window."
}),
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());Response (201):
{
"object": "conversation_note",
"id": "cnv_1a2b3c4d5e6f47a8b9c0d1e2f3a4b5c6",
"conversation_id": "cnv_1a2b3c4d5e6f47a8b9c0d1e2f3a4b5c6",
"contact_id": "con_0f8c1a2e4b7d4c3e9a5b6d7e8f901234",
"text": "Prefers a table by the window.",
"created_at": "2026-10-25T09:41:07Z"
}#Response
Status 201. Every response has the headers Request-Id, SmartChat-Version and X-RateLimit-*.
| Name | Type | Description |
|---|---|---|
object | string | Always "conversation_note". always conversation_note |
id | string | Same as conversation_id: a contact has one note, so a single line has no ID of its own. |
conversation_id | string | Conversation ID. |
contact_id | string | Contact ID. |
text | string | The text you added (without the date line). Untrusted text. up to 5000 characters; untrusted text |
created_at | string | When the line was added. up to 40 characters; format date-time |
#Errors
| Code | Status | When |
|---|---|---|
bad_request | 400 | The request could not be read. |
idempotency_key_invalid | 400 | The 'Idempotency-Key' header must be 1 to 255 visible ASCII characters. |
idempotency_key_required | 400 | This call needs an 'Idempotency-Key' header. |
missing_parameter | 400 | A required field is missing. |
unknown_parameter | 400 | A field is not known. |
api_key_expired | 401 | This API key has expired. |
api_key_invalid | 401 | This API key is not valid. |
api_key_revoked | 401 | This API key was revoked. |
authentication_required | 401 | No API key was sent. Send 'Authorization: Bearer <key>'. |
account_blocked | 403 | This account is blocked. |
insufficient_scope | 403 | This key lacks a required permission. |
ip_not_allowed | 403 | This IP address is not allowed for this key. |
contact_not_found | 404 | No contact with this ID exists in this account. |
conversation_not_found | 404 | No conversation with this ID exists in this account. |
idempotency_in_progress | 409 | A request with this idempotency key is still running. |
idempotency_key_reused | 422 | This idempotency key was already used with a different request. |
validation_failed | 422 | A field is not valid. |
rate_limited | 429 | Too many requests. Wait and try again. |
internal_error | 500 | Something went wrong on our side. |
service_unavailable | 503 | The service is temporarily unavailable. |
All errors use one format.