Update workflow status

Request

PATCH /v2/workflows/20 HTTP/1.1
Authorization: Bearer oauth_token
Content-Type: application/json

{
  "value" : "active",
  "op" : "replace",
  "path" : "/status"
}

Path Parameters

/v2/workflows/{workflowId}

Request fields

Path Type Required Description
op String Y Patch operation, only replace is supported for this endpoint at the moment
value String Y Indicating status you wish to change the workflow to have, valid values are active
inactive
path String Y Path to change entity, one of /status

Response

HTTP/1.1 204 No Content
Set-Cookie: JSESSIONID=3D4C4162B226C3D023A6F16311AF83BA; Path=/; HttpOnly
↑Back to top
© Help Scout 2024