Patch Workflow

Partially update a workflow. Only fields present in the body are applied.

AuthorizationBearer

Clerk JWT token

workflow_idstringRequiredformat: "uuid"

This endpoint expects an object.

namestring or nullOptional1-200 characters

descriptionstring or nullOptional<=5000 characters

definitionobject or nullOptional

Successful Response

dataobject

metaobject

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 '{}'

1	{
2	"data": {
3	"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4	"user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
5	"name": "Data Processing Workflow",
6	"definition": {},
7	"created_at": "2024-01-15T09:30:00Z",
8	"updated_at": "2024-01-15T09:30:00Z",
9	"description": "Workflow to process and analyze incoming data streams.",
10	"runs_count": 42,
11	"last_run_at": "2024-04-10T14:45:00Z",
12	"last_run_status": "completed"
13	},
14	"meta": {
15	"request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
16	"timestamp": "2024-04-10T15:00:00Z"
17	}
18	}

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

1	{
2	"data": {
3	"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4	"user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
5	"name": "Data Processing Workflow",
6	"definition": {},
7	"created_at": "2024-01-15T09:30:00Z",
8	"updated_at": "2024-01-15T09:30:00Z",
9	"description": "Workflow to process and analyze incoming data streams.",
10	"runs_count": 42,
11	"last_run_at": "2024-04-10T14:45:00Z",
12	"last_run_status": "completed"
13	},
14	"meta": {
15	"request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
16	"timestamp": "2024-04-10T15:00:00Z"
17	}
18	}