Show Developer Menu

PUT /conversations/{slug}

Issuing a PUT call to conversations will allow you to update a conversation.

Example Request
curl 'https://{brand}{slug}' \
  -u {login-email}:{api-token} \
  -H 'Accept: application/json' \
  -H 'Content-type: application/json' \
  -X PUT -d '{"conversation": {"assignee": {"email": "[email protected]"}, "tag_list": ["tag1", "tag2"], "status": 0, "data": {"field1": "value1", "field2": "value2"}}}'

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

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

  • You can optionally pass in a tag_list array of strings to update the conversation's tags.
  • You can optionally pass in a status integer attribute to set the conversation status. Valid status values are enumerated in the Retrieving Conversations page. If status is set to 5 (On Hold), a hold_until datetime attribute must also be passed in.
  • You can optionally pass in a data hash attribute to update the conversation's custom field attributes.
  • You can optionally pass in a assignee hash attribute to reassign the conversation to a specific staff user. The hash must contain an email attribute that corresponds to the email address of the staff user that's being assigned to the conversation.
  • You can optionally pass in a category string attribute to move the conversation into a different channel. The designated channel must be an email channel.
  • You can optionally pass in a brand string attribute. This should only be used when moving a conversation to a different channel, and should be the brand url of the destination email channel.