Toggle workflow on or off - Ocoya API Docs

Enables or disables the workflow. Returns nothing. Turning on is refused with the unfinished steps listed under problems until every step is set up.

POST

https://www.app.ocoya.com/api/_public/v1/workflow/{workflowId}

Toggle workflow on or off

cURL

curl --request POST \
  --url https://www.app.ocoya.com/api/_public/v1/workflow/{workflowId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "on": true
}
'

{}

Authorizations

X-API-Keystringheaderrequired

Your API key. Create one in Ocoya. Authorization: Bearer <key> works too.

Path Parameters

workflowIdstringrequired

Ocoya workflow ID.

Example:"cmajvvb9q0003ja5vh0538j6r"

Body

application/json

onbooleanrequired

Set to true to enable the workflow or false to disable it.

Example:true

Response

200application/json

Success. An empty object.

Toggle workflow on or off

cURL

curl --request POST \
  --url https://www.app.ocoya.com/api/_public/v1/workflow/{workflowId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "on": true
}
'

{}

Was this page helpful?