Update Workflow

curl -X PUT https://api.onepin.ai/api/v1/workflows/workflow_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Customer Data Enrichment Workflow",
  "definition": {}
}'

{
  "data": {
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "user_id": "a12b3c4d-5e6f-7g8h-9i0j-k1l2m3n4o5p6",
    "name": "Customer Data Enrichment Workflow",
    "definition": {},
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z",
    "description": "Workflow to enrich customer data with external API sources and validate results.",
    "runs_count": 42,
    "last_run_at": "2024-04-10T14:45:00Z",
    "last_run_status": "completed"
  },
  "meta": {
    "request_id": "req_7f8e9d6c-1234-5678-9abc-def012345678",
    "timestamp": "2024-04-10T15:00:00Z"
  }
}

Replace a workflow’s name, description, and definition (full update).

All fields in the request body are required. The definition is validated before persisting; an invalid graph returns 422. Existing runs are not affected — each run captures a definition_snapshot at start time. Requires at least editor role. Use PATCH to update only specific fields without supplying the full definition.

Replace a workflow's name, description, and definition (full update). All fields in the request body are required. The `definition` is validated before persisting; an invalid graph returns 422. Existing runs are not affected — each run captures a `definition_snapshot` at start time. Requires at least `editor` role. Use `PATCH` to update only specific fields without supplying the full definition.

Authentication

AuthorizationBearer

Clerk JWT token

AuthorizationBearer

Onepin live API key (op_live_...). Test and public keys are reserved in Phase 1.

Path parameters

workflow_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

namestringRequired1-200 characters

Human-readable workflow name (1–200 characters, non-blank).

definitionobjectRequired

Full replacement graph and execution config. Must be valid.

descriptionstring or nullOptional<=5000 characters

Optional description (max 5000 characters). Pass null to clear.

Response

Successful Response

dataobject

metaobject

Errors

422

Unprocessable Entity Error

Authentication

Path parameters

Headers

Request

Response

Errors