For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • Get Started
    • Introduction
    • Quickstart
    • Authentication
  • API Reference
      • GETList Workflows
      • POSTCreate Workflow
      • GETGet Workflow
      • PUTUpdate Workflow
      • DELDelete Workflow
      • PATCHPatch Workflow
      • GETList Workflow Uploads
      • POSTPreview Run
      • GETRuns Summary
      • GETGet Run Steps
      • GETGet Run Overview
      • GETGet Run Data
      • GETDownload Run
      • GETDownload Run Node
      • POSTDuplicate Workflow
  • Python SDK
    • Install
    • Usage
    • Errors
  • CLI
    • Overview
LogoLogo
API Referenceworkflows

Patch Workflow

PATCH
/api/v1/workflows/:workflow_id
PATCH
/api/v1/workflows/:workflow_id
$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}
Partially update a workflow. Only fields present in the body are applied.
Was this page helpful?
Previous

List Workflow Uploads

Next
Built with

Authentication

AuthorizationBearer
Clerk JWT token

Path parameters

workflow_idstringRequiredformat: "uuid"

Headers

X-Workspace-Idstring or nullOptional

Request

This endpoint expects an object.
namestring or nullOptional1-200 characters
descriptionstring or nullOptional<=5000 characters
definitionobject or nullOptional

Response

Successful Response
dataobject
metaobject

Errors

422
Unprocessable Entity Error