Patch Workflow

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "name": "Customer Onboarding Workflow",
    "definition": {},
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z",
    "description": "Workflow to automate the customer onboarding process including data validation and welcome email.",
    "runs_count": 42,
    "last_run_at": "2024-04-10T14:45:00Z",
    "last_run_status": "completed"
  },
  "meta": {
    "request_id": "req_123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2024-04-10T15:00:00Z"
  }
}

Partially update a workflow — only supplied fields are changed.

Any combination of name, description, and definition may be included; omitted fields are left unchanged. At least one field must be present (empty body returns 422). If definition is provided it is fully validated; an invalid graph returns 422. Requires at least editor role.

Use PUT when replacing the full workflow definition in one operation.

Partially update a workflow — only supplied fields are changed. Any combination of `name`, `description`, and `definition` may be included; omitted fields are left unchanged. At least one field must be present (empty body returns 422). If `definition` is provided it is fully validated; an invalid graph returns 422. Requires at least `editor` role. Use `PUT` when replacing the full workflow definition in one operation.

Authentication

AuthorizationBearer

Clerk JWT token

Path parameters

workflow_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

namestring or nullOptional1-200 characters

New workflow name (1–200 characters). Omit to leave unchanged.

descriptionstring or nullOptional<=5000 characters

New description (max 5000 characters). Omit to leave unchanged; pass null to clear.

definitionobject or nullOptional

Replacement graph and execution config. Omit to leave unchanged; must be valid if supplied.

Response

Successful Response

dataobject

metaobject

Errors

422

Unprocessable Entity Error

$	curl -X PATCH https://api.onepin.ai/api/v1/workflows/workflow_id \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

Authentication

Path parameters

Headers

Request

Response

Errors