Hodoflow / Developers
Sign in
Browse documentation
Help Center →
Browse API reference
JSON:API v1 stable

Save workflow builder state

Atomically save a workflow definition together with its steps, triggers, and mappings.

POST /api/json/v1/workflows/save_builder_state

Access and behavior

Required scope
api_write
Authentication
Bearer token
Idempotency
supported
Operation ID
saveWorkflowBuilderState

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.

Request body

application/vnd.api+json

Schema: object · Required

is_new_version

Required

boolean

Is new version accepted by this operation.

organization_id

Required

string

Organization that owns the resource.

step_params

Required

array<object>

Step params accepted by this operation.

trigger_params

Required

array<object>

Trigger params accepted by this operation.

wf_params

Required

object

Wf params accepted by this operation.

workflow_id

Optional

string | null

Workflow that owns or produced the resource.

request.json 
{
  "data": {
    "attributes": {
      "is_new_version": false,
      "organization_id": "00000000-0000-4000-8000-000000000001",
      "step_params": "<step_params>",
      "trigger_params": "<trigger_params>",
      "wf_params": "<wf_params>",
      "workflow_id": "00000000-0000-4000-8000-000000000001"
    },
    "type": "resource"
  }
}

Success response

201 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.
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.