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

Update Workflow

PUT
/api/v1/workflows/:workflow_id
PUT
/api/v1/workflows/:workflow_id
$curl -X PUT https://api.onepin.ai/api/v1/workflows/workflow_id \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "name": "Data Processing Workflow",
>  "definition": {}
>}'
1{
2  "data": {
3    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4    "user_id": "7e57d004-2b97-0e7a-b45f-5387367791cd",
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": 12,
11    "last_run_at": "2024-04-20T14:45:00Z",
12    "last_run_status": "completed"
13  },
14  "meta": {
15    "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
16    "timestamp": "2024-04-20T15:00:00Z"
17  }
18}
Update a workflow.
Was this page helpful?
Previous

Delete Workflow

Next
Built with

Authentication

AuthorizationBearer
Clerk JWT token
OR
AuthorizationBearer

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

Path parameters

workflow_idstringRequiredformat: "uuid"

Headers

X-Workspace-Idstring or nullOptional

Request

This endpoint expects an object.
namestringRequired1-200 characters
definitionobjectRequired
descriptionstring or nullOptional<=5000 characters

Response

Successful Response
dataobject
metaobject

Errors

422
Unprocessable Entity Error