OCocoya
Workflows

Toggle workflow on or off

Changed on

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/workflow/{workflowId}

Request

  • Base URL
    https://www.app.ocoya.com/api/_public/v1
  • Auth
    API key in header X-API-Key

Path parameters

workflowIdstring required
Example:cmajvvb9q0003ja5vh0538j6r

Ocoya workflow ID.

Request body

onboolean required

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

Example request

{
  "on": true
}

Response

Success. An empty object.

object required

Example response

{}

Changes

  • ad0d7f3cdd9bRevision changes
    • breaking

      request body became required

    • info

      api operation id toggleWorkflow was added

    • info

      api tag Workflows added

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status