Legacy Mailbox API 1.0 is deprecated

Support for legacy Mailbox API 1.0 was ended on June 6, 2019. Please use Mailbox API 2.0 going forward. If you have any questions or need help with the new API, please reach out.

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
↑Back to top
© Help Scout 2019