Show Developer Menu

PUT /contacts/{identifier}

Issuing a PUT call to a specific contact will allow you to update the contact.

Alternative: PUT /contacts/{identifier}?identifier_type={identifier_type}

Alternatively, you can issue a PUT to a specific contact by an alternative identifier type, like mobile, facebook, twitter, or instagram.

Example Request
curl 'https://{brand}.reamaze.io/api/v1/contacts/{email}' \
  -u {login-email}:{api-token} \
  -H 'Accept: application/json' \
  -H 'Content-type: application/json' \
  -X PUT -d '{"contact": {"name": "bob", "notes": ["New note", "Another new note"],"data": {"custom_attribute": "custom data"}}}'
Response

A successful request will return the JSON for the updated contact.

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

Notes
  • It's not possible to change the email, mobile or other identifier for a contact. This endpoint can only be used for changing the name, friendly_name, external_avatar_url and data attributes.
  • When providing identifier_type the identifier value needs to be match the type. For example, if identifier_type is mobile then identifier will need to be something like +12223334444.
  • It is possible to add new notes to a contact when updating, but to update a note you must use the Contact Notes API