marulaDocs
Documentation menu

API reference

4 operations in workflow-overrides. Raw spec: openapi.json.

GET/api/v1/clients/{id}/workflow-overrides

GET /api/clients/{id}/workflow-overrides — the client's resolved workflow: one entry per registry declaration with precedence outcome, provenance, renderable details (names + semantic status categories), and drift issues.

Parameters

NameInTypeRequiredDescription
idpathstringYes

Responses

StatusDescription
200
404client not found in this org

Security: bearer

PUT/api/v1/clients/{id}/workflow-overrides/{key}

PUT /api/clients/{id}/workflow-overrides/{key} — set a value or record an explicit disable. Unknown keys, mistyped payloads, out-of-org references, and disallowed disables are typed 422s before anything persists.

Parameters

NameInTypeRequiredDescription
idpathstringYes
keypathstringYes

Request body

PutOverrideRequest

Responses

StatusDescription
200
404client not found in this org (rls_sparse in-mutation)
409version conflict or idempotency key reused
422unregistered key, mistyped value, invalid reference, or disallowed disable

Security: bearer

DELETE/api/v1/clients/{id}/workflow-overrides/{key}

DELETE /api/clients/{id}/workflow-overrides/{key} — remove the override so the client inherits the org default again. Distinct from an explicit disable; clearing an absent override is a no-op that still resolves.

Parameters

NameInTypeRequiredDescription
idpathstringYes
keypathstringYes

Responses

StatusDescription
200
404client not found in this org (rls_sparse in-mutation)
422unknown override key

Security: bearer

GET/api/v1/workflow-overrides/registry

GET /api/workflow-overrides/registry — the closed set of overridable constructs with their typed value kinds (the UI renders the editor FROM this; policy §4.5: customizations are data against a typed registry).

Responses

StatusDescription
200

Security: bearer