We're upgrading our API

On June 6th, 2019, Mailbox API 1.0 will be sunsetted, and at that time any apps using this legacy API will no longer work. Please use Mailbox API 2.0 instead.

Run Workflow on Multiple Conversations

  • REST Method: POST
  • URL: https://api.helpscout.net/v1/workflows/{id}/conversations.json
  • Content-Type: application/json

Applies the actions for the specified manual workflow on each conversation specified in the body of the request. Specifying an automatic workflow will return an error.

Request

Name Type Required Default Notes
converationIds Array Y   The body of the request. An array of conversation ids. The workflow actions will be applied to each conversation in the list.
{
    "conversationIds": [
        123876,
        456217,
        789349,
        098234
    ]
}

Response

Response Name Type Notes
Header Status Integer 200
Status: 200 OK