Skip to content

Updates description/enabled (write-tier, revisioned).

PATCH
/v1/m/orchestration/workflows/{id}
curl --request PATCH \
--url https://example.com/v1/m/orchestration/workflows/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "description": "example", "enabled": true }'

Updates description/enabled (write-tier, revisioned). Disabling stops NEW runs; a running run finishes (documented behavior).

id
required
string

Path parameter id.

X-Olivares-Tenant
string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Media type application/json
Any of:
object
description
Any of:

An explicit empty string clears the stored description.

string
enabled
Any of:
boolean
Example generated
{
"description": "example",
"enabled": true
}

OK

Media type application/json
object
Example generated
{}

Bad request

Media type application/json
object
Example generated
{}

Unauthenticated

Media type application/json
object
Example generated
{}

Forbidden

Media type application/json
object
Example generated
{}

Not found

Media type application/json
object
Example generated
{}

Conflict / setup required

Media type application/json
object
Example generated
{}

Rate limited

Media type application/json
object
Example generated
{}