Skip to main content
PATCH
/
v1
/
workflows
/
{workflow_id}
from retab import Retab

client = Retab()

workflow = client.workflows.update(
    "wf_abc123xyz",
    name="Invoice Processing v2",
    description="Extract invoice fields, validate, and route for review",
)

{
  "id": "wf_abc123xyz",
  "name": "Invoice Processing v2",
  "description": "Extract invoice fields, validate, and route for review",
  "published": {
    "version_id": "ver_8zJfV7T9qK2mP4xN6bR1cD3eF5gH7iJ9",
    "published_at": "2026-04-30T18:00:00Z"
  },
  "created_at": "2026-04-30T17:00:00Z",
  "updated_at": "2026-05-01T14:30:00Z"
}
Update workflow metadata. Only the fields you supply are touched — omit a field to leave it unchanged. 
from retab import Retab

client = Retab()

workflow = client.workflows.update(
    "wf_abc123xyz",
    name="Invoice Processing v2",
    description="Extract invoice fields, validate, and route for review",
)

{
  "id": "wf_abc123xyz",
  "name": "Invoice Processing v2",
  "description": "Extract invoice fields, validate, and route for review",
  "published": {
    "version_id": "ver_8zJfV7T9qK2mP4xN6bR1cD3eF5gH7iJ9",
    "published_at": "2026-04-30T18:00:00Z"
  },
  "created_at": "2026-04-30T17:00:00Z",
  "updated_at": "2026-05-01T14:30:00Z"
}

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
workflow_id
string
required

Body

application/json

Body for updating a workflow. Only the supplied fields (name, description) are changed.

​
name
string | null

The name of the workflow

Maximum string length: 200
​
description
string | null

Description of the workflow

Maximum string length: 4000

Response

Successful Response

A workflow and its current configuration.

​
id
string
required

Unique ID for this workflow

​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
name
string
default:Untitled Workflow

The name of the workflow

​
description
string
default:""

Description of the workflow

​
project_id
string | null

Project that owns this workflow. Null means the organization's shared workflows project.

​
published
WorkflowPublished · object

Published workflow metadata when a published version exists

​
capabilities
enum<string>[] | null

Server-derived permissions for the current actor.

Available options:
workflow:view,
workflow:edit,
workflow:run,
workflow:delete,
workflow:publish,
workflow:review,
workflow:manage
​
authz_status
enum<string> | null

Provisioning state of this workflow's WorkOS authorization resource.

Available options:
provisioning,
ready,
failed,
deleting,
deleted