A valid request URL is required to generate request examples{
"note": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"author": "<string>",
"body": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Write an internal note about a contact
Requires customers:write. Records one note against this contact, attributed to the staff member whose session made the call.
A note survives the merge that folds this contact into another — what the team knows about a person follows the person — and it is deleted with them by an erasure, which also means it appears in the subject access export. Write accordingly.
body is required, trimmed, and capped at 4,000 characters; both ends are refused with invalid_request.
A valid request URL is required to generate request examples{
"note": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"author": "<string>",
"body": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Autorizações
A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.
Cabeçalhos
The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing: the answer is not_a_member (403), which does not mean the session is over. Absent, the session's default organization answers, or — if that membership was revoked while the session was open — any other one the caller still holds.
Parâmetros de caminho
Parâmetros de consulta
Which environment to act in. A view parameter, valid only on the staff surface — a machine credential never chooses its environment, it is resolved from the key.
live, test Corpo
4000Resposta
The note, as it was stored.
Show child attributes
Show child attributes