JSON:API
v1
stable
Activate a workflow
Activate a validated workflow version and deactivate its active siblings.
PATCH
/api/json/v1/workflows/{id}/activate
Access and behavior
- Required scope
- api_write
- Authentication
- Bearer token
- Idempotency
- supported
- Operation ID
- activateWorkflow
Request headers
| Header | Presence | Description |
|---|---|---|
| Authorization | Required | Short-lived service-account bearer token. |
| Accept | Required | JSON:API response media type. |
| Idempotency-Key | Optional | Makes an unsafe request replay-safe for the configured retention window (24 hours by default). Reusing a key with different request parameters returns 409. |
| Content-Type | Required | Request document media type. |
Parameters
id
path · Required
string
No description provided.
include
query · Optional
string
Relationship paths to include in the response
fields
query · Optional
object
Limits the response fields to only those listed for each type
Request body
application/vnd.api+json
Schema: object
· Optional
request.json
{
"data": {
"attributes": {},
"type": "resource"
}
}Success response
200
Success
- Media type
- application/vnd.api+json
- Schema
- object
Errors and retries
Keep x-request-id
from failed responses. Retry only rows marked retryable, and obey
Retry-After
when present.
| Status | Code | Recovery | Meaning |
|---|---|---|---|
| 401 | unauthorized | Do not retry unchanged | A valid bearer token is required. |
| 403 | forbidden | Do not retry unchanged | The service account lacks the required scope or object access. |
| 429 | rate_limited | Retry after guidance | The request exceeded its rate window; wait for Retry-After. |
| 404 | not_found | Do not retry unchanged | The resource was not found or is not visible to the run-as member. |
| 409 | idempotency_key_reused | Do not retry unchanged | The key was previously used for a different request. |
| 422 | invalid_request | Do not retry unchanged | The request document failed resource validation. |
Related guides
JSON:API documents and media types
Read and write Hodoflow's path-versioned JSON:API documents with the correct envelopes, headers, resource identities, and relationships.
List and inspect workflows
Retrieve a bounded workflow collection, select one resource, and inspect its exact JSON:API attributes and response headers.
Perform an idempotent write
Create one test dashboard through JSON:API, replay the identical request safely, and recognize a conflicting key reuse.