Set workflow status

PATCH

/v1/brands/{brandId}/workflows/{workflowId}/status

Authorization

bearerAuth

headerAuthorizationBearer <token>

An organization API key (koast_sk_…) with the API surface enabled, or an OAuth access token issued by Koast (koast_at_…) whose audience covers this API. REST access requires an active Agency plan.

Path Parameters

brandId*integer

The brand the request acts on. Every brand-scoped resource lives under its brand.

workflowId*string

Match^[1-9]\d*$

Length1 <= length

Request Body

application/json

body

status*string

Value in"DRAFT""ACTIVE""PAUSED"

Response Body

Set workflow status

application/json

response

[key: string]?unknown

curl -X PATCH "https://example.com/v1/brands/0/workflows/string/status" \  -H "Authorization: Bearer koast_sk_..." \  -H "Content-Type: application/json" \  -d '{    "status": "DRAFT"  }'

{  "property1": null,  "property2": null}

Required scope: write. CLI: koast set-workflow-status, see Workflows commands. Authentication, headers, errors and pagination work the same on every operation. See Conventions.