> This page is for version v2024-12-23.
> For other versions, use one of these documentation indexes:
> - v2026-02-09 (default): https://docs.extend.ai/2026-02-09/llms.txt
> - v2025-04-21: https://docs.extend.ai/2025-04-21/llms.txt
> - v2024-12-23: https://docs.extend.ai/2024-12-23/llms.txt

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.extend.ai/llms.txt
> Use this file to discover all available pages before exploring further.
>
> ## API version
> The current API version is `2026-02-09`, served at the site root (no version prefix in URLs).
> If this page URL contains `/2025-04-21/` or `/2024-12-23/`, you are reading an older API version.
> Prefer the current docs at https://docs.extend.ai/llms.txt unless the user explicitly needs that older version.
> Do not treat older-version pages as the source of truth for new integrations.

# Update Workflow Run

### Parameters

**`id`** `string`

The ID of the WorkflowRun that was outputted after you created it using the
/workflow\_runs endpoint.

---

### Body

**`name`** `string`

An optional name that can be assigned to a specific WorkflowRun.

---

**`metadata`** `any`

A metadata object that can be assigned to a specific WorkflowRun. If metadata
already exists on the WorkflowRun, this new metadata object will be merged
with it, with the new metadata taking field precedence.

To categorize runs for billing and usage tracking, include usage tags with the `extend:usage_tags` key.

---

### Response

**`workflowRun`** `WorkflowRun`

An object representing a WorkflowRun. See the [WorkflowRun object](/2024-12-23/developers/objects/workflow-run) for the shape of the data.

---

**`Workflow`** `object`

#### properties

**`id`** `string`

The Workflow ID that can be fetched from the Extend Platform.

---

**`name`** `string`

The name of the Workflow.

---

**`version`** `string`

The version of the Workflow.

---

---

**`Example Request`**

```bash Example Request
curl --location --request POST 'https://api-prod.extend.app/workflow_runs/:id' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API_TOKEN>' \
--data '{
    "name": "test_workflow",
    "metadata": {
      "internal_id": "id_1234"
    }
}'
```

**`Example Response`**

```json Example Response
{
  "success": true,
  "workflowRun": {
    "object": "workflow_run",
    "id": "workflow_run_1234",
    "status": "PROCESSED",
    "metadata": {
      "internal_id": "id_1234"
    },
    "initialRunAt": "2023-01-01T09:41:00.000Z",
    "reviewedBy": "user_1234",
    "reviewedAt": "2023-01-10T05:39:14.500Z",
    "startTime": "2023-01-01T09:41:00.000Z",
    "endTime": "2023-01-10T05:39:24.500Z",
    "files": [
      {
        "object": "file",
        "id": "file_1234",
        "name": "example_file_name.pdf",
      }
    ],
    "outputs": [
      {
        "object": "document_processor_run",
        "id": "dpr_1234",
        "edited": true,
        "type": "EXTRACT",
        "initialOutput": {
          // Output object - see “Processor output types” for details
        },
        "reviewedOutput": {
          // Output object - see “Processor output types” for details
        },
        "output": {
          // Output object - see “Processor output types” for details
        }
      }
    ],
    "workflow": {
      "object": "workflow",
      "id": "workflow_1234",
      "version": "1",
      "name": "test_workflow"
    }
  }
}
```