Show Developer Menu

POST /conversations

Issuing a POST call to conversations will allow you to create new conversations on behalf of a customer. This is ideal for integrations like custom support forms.

Example Request
curl 'https://{brand}.reamaze.io/api/v1/conversations' \
  -u {login-email}:{api-token} \
  -H 'Accept: application/json' \
  -H 'Content-type: application/json' \
  -X POST -d '{"conversation": {"subject": "foo", "category": "support", "tag_list": ["tag1", "tag2"], "message": {"body": "bar", "recipients" : ["alice@example.com"]}, "user": {"name": "bob", "email": "bob@example.com"}}}'
Response

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

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

Notes
  • The category attribute should be set to the slug of the Channel where this Conversation should be created. The slug is the alphanumeric identifier for a Channel in Re:amaze provided by the part before the @ in the Channel Email Address.
  • You can optionally pass in a tag_list array of strings to tag the conversation.
  • You can optionally pass in a status integer attribute to set the conversation status. Valid status values are enumerated in the Retrieving Conversations page.
  • You can optionally pass in a data hash attribute as part of the conversation to pass in custom field attributes for the conversation.
  • You can optionally pass in a message[recipients] array attribute as part of the conversation to pass in additional participants in the conversation. These participants will be automatically added as recipients in future correspondences within the thread.
  • You can optionally pass in a message[suppress_notification] boolean attribute with a value of true to prevent Reamaze from sending any email (or integration) notifications related to this message.
  • You can optionally pass in a message[suppress_autoresolve] boolean attribute with a value of true to prevent Reamaze from marking the conversation as resolved when message[user] is a staff user.
  • You can optionally pass in a message[attachment] string attribute with a URL to attach a file to the message. The URL should specify a valid location where Reamaze can fetch the file.