Create a note on a contact

Adds a note to the contact named in the path. The path says which contact owns the note, so the body does not name one: owner and ownerType are dropped, and reltype and relid are replaced with the contact from the path. The author is the authenticated API user. Unless the note is a draft, the contact note webhook fires. Returns 404 when the contact does not exist, 422 when the body has no note object or its note text is missing or blank, 400 when listId is not a whole number of 0 or more, and 403 when the API user may not edit contacts.

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

ID of the contact the note is created on

Body Params
note
object
required

The note to create.

Responses

400

listId is not a whole number of 0 or more. Body: errors, a list with one item carrying status, title and detail.

403

The API user may not edit contacts. Body: errors, a list with one item carrying status, title and detail.

404

No contact with that id. Body: message, a sentence naming the id.

422

The body has no note object, or its note text is missing or blank. A body that is not a JSON object, or a note member that is not an object, is treated as an empty note. 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