Show Developer Menu

POST /contacts/{email|phone}/notes

Issuing a POST call to notes will allow you to attach an note to a contact.

Example Request
curl 'https://{brand}.test-reamaze.com/api/v1/contacts/{email|phone}/notes' \
  -u {login-email}:{api-token} \
  -H 'Accept: application/json' \
  -H 'Content-type: application/json' \
  -X POST -d '{ "body": "New note body" }'
Response

A successful request will return the JSON containing all notes for this contact, which includes your new note.

A failed request will return an HTTP 422 Unprocessable Entity with the JSON body explaining the error.

Notes
  • This allows you to create one note for a contact. You can also create many notes at a time for a contact through the update contacts endpoint
  • creator_email is optional and should be the staff email address for the Reamaze STAGING staff user who you want to be attributed to creating the note. Otherwise, the creator will be the user making the request.
  • created_at is optional and will default to the current time.