Update a note on a contact

Changes one of the contact's own notes. PATCH on this path does the same. The note must belong to the contact in the path: a note on another contact, on a deal or on an account is a 404 here. Only the user who wrote the note may change it. Fields left out of the body keep their values, and mdate is set to now. When is_draft goes from 1 to 0, the draft is published and the contact note webhook fires for every list. Returns 404 when the contact does not exist, the note is not one of its notes, or the API user may not edit contacts; 403 when the API user did not write the note; and 422 when the note text is set to blank.

Path Params
string
required
^(?:\d+)$

ID of the contact the note belongs to

string
required
^(?:\d+)$

ID of the note to update

Body Params
note
object

The changes to make. Every member is optional. A body that is not a JSON object, or a note member that is not an object, is treated as an empty note: only mdate changes.

Responses

403

The API user did not write the note. Body: a plain-text sentence, not JSON.

404

No contact with that id: body message, a sentence naming the contact id. The API user may not edit contacts: body message, a sentence naming the note id. Or the note is not one of this contact's notes: body errors, a list with one item carrying status, title and detail.

422

The body sets the note text to blank or null. Body: errors, a list with one item carrying title, detail, code (field_missing), error and source.pointer (/data/attributes/note).

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json