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.

Update Workflow

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

Note: At this time, this endpoint will only update the status of a workflow to either 'active' or 'inactive'. Any other attributes passed will be ignored.

Request

Name Type Required Default Notes
workflow Workflow Y   The body of the request (see example below).
reload boolean N false Set this request parameter to true to return the workflow in the response.
{
    "status": "active"
}

Accepted Fields

Name Type Required Default Notes
status string Y   Must be set to either 'active' or 'inactive'

Response

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