Show Developer Menu

POST /contacts

Issuing a POST call to contacts will allow you to create new contact.

Example Request
curl 'https://{brand}' \
  -u {login-email}:{api-token} \
  -H 'Accept: application/json' \
  -H 'Content-type: application/json' \
  -X POST -d '{"contact": {"name": "bob", "email": "", "id": "123", "data": {"custom_attribute": "custom data"}}}'

A successful request will return the JSON for the newly created contact.

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

  • The id uniquely identifies a contact and should correspond to the id internal to your application or authentication system.
  • email must be provided.
  • data can be set of key/value pairs to associate with the user, but can only be one level deep. It will display as Customer Data Attributes in Reamaze.