# Save workflow draft

> Save a whole document over the latest draft, as the builder's Save does: the triggers of the new and changed steps (schedules, email, Gmail, queue consumers, sync triggers) are set up first, then the document is saved. A deployed latest version needs a new draft first (POST /workflows/<workflow_id>/drafts).

Source: https://docs.stacksync.com/api-reference/workflows/save_workflow_draft

`PATCH https://api.stacksync.com/v1/workspaces/{workspace_id}/workflows/{workflow_id}/draft`

- Operation: `save_workflow_draft`
- Resource: Workflows
- Access: writes data

## Authentication

- `Authorization: Bearer <key>`: A workspace API key (workspace_…, created by a workspace owner under Workspace settings > Stacksync API) acts with editor rights on that workspace only; a user API key (user_…, created under Profile > Stacksync API) acts as that user in every workspace they belong to. POST, PUT and PATCH requests must send Content-Type: application/json. Every authentication failure answers 403.
- `Content-Type: application/json` on every request with a body.

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `workspace_id` | integer | Yes | The workspace. List the ones your key can reach with GET /v1/workspaces. |
| `workflow_id` | string (uuid) | Yes | The workflow. |

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `region` | string (besg \| usnv) | Yes | Region of the resource: besg (Europe) or usnv (United States), as GET /v1/regions lists them |

## Request body

`application/json`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `document` | object (WorkflowSchemaModel) | Yes |  |
| `document.workflow_execution_timeout` | integer \| null, default 300 | No |  |
| `document.workflow_module_execution_timeout` | integer \| null, default 300 | No |  |
| `document.return_workflow_module_instance_ids` | array of string \| null | No |  |
| `document.modules` | array of object (WorkflowSchemaModuleModel) | Yes |  |
| `document.modules[].name` | string | Yes |  |
| `document.modules[].workflow_module_instance_id` | string | Yes |  |
| `document.modules[].module_id` | string | Yes |  |
| `document.modules[].description` | string \| null | No |  |
| `document.modules[].properties` | object | Yes |  |
| `document.modules[].connections` | array of object (WorkflowModuleConnectionManagedModelByResourceId) \| object (WorkflowModuleConnectionManagedModelByName) \| object (WorkflowModuleConnectionUserDataModel), default [] | No |  |
| `document.modules[].module_options` | object (WorkflowSchemaModuleOptionsModel) \| null | No |  |
| `document.modules[].module_options.patches` | object \| null | No |  |
| `document.modules[].module_options.layout` | object (WorkflowSchemaModuleOptionsLayoutModel) \| null | No |  |
| `document.modules[].module_options.layout.group_module_instance_id` | string \| null | No |  |
| `document.modules[].module_options.enable_error_handling` | boolean \| null | No |  |
| `document.modules[].module_options.workflow_module_execution_timeout` | integer \| null | No |  |
| `document.modules[].error_handling_strategy` | object (WorkflowModuleErrorStrategyModel) \| null | No |  |
| `document.modules[].error_handling_strategy.conditions` | array of object (WorkflowModuleErrorStrategyConditionModel), default [] | No |  |
| `document.modules[].error_handling_strategy.conditions[].condition` | object (WorkflowModuleConditionGroupModel) \| object (WorkflowModuleConditionValueModel) \| object (WorkflowModuleConditionComparatorModel) | Yes |  |
| `document.modules[].error_handling_strategy.conditions[].retry_policy` | object (WorkflowModuleErrorStrategyConditionActionModel) | Yes |  |
| `document.modules[].error_handling_strategy.conditions[].retry_policy.retry_count` | integer, default 0 | No |  |
| `document.modules[].error_handling_strategy.conditions[].retry_policy.retry_interval` | integer, default 0 | No |  |
| `document.modules[].error_handling_strategy.else_condition` | object (WorkflowModuleErrorStrategyConditionActionModel) \| null | No |  |
| `document.modules[].error_handling_strategy.else_condition.retry_count` | integer, default 0 | No |  |
| `document.modules[].error_handling_strategy.else_condition.retry_interval` | integer, default 0 | No |  |
| `document.edges` | array of object (WorkflowSchemaEdgeModel) | Yes |  |
| `document.edges[].source` | object (WorkflowSchemaEdgeHandleModel) | Yes |  |
| `document.edges[].source.handle_id` | string \| null | No |  |
| `document.edges[].source.workflow_module_instance_id` | string | Yes |  |
| `document.edges[].target` | object (WorkflowSchemaEdgeHandleModel) | Yes |  |
| `document.edges[].target.handle_id` | string \| null | No |  |
| `document.edges[].target.workflow_module_instance_id` | string | Yes |  |
| `document.edges[].edge_id` | string | Yes |  |
| `expected_version` | string \| null | No | The draft version you read; refused with 409 when the draft is another one |
| `expected_last_modified_time` | string (date-time) \| null | No | The last_modified_time of the draft you read; refused with 409 when it changed |
| `validate_only` | boolean, default false | No | Run every check of the write and answer 204 without writing: a refused write answers the error the write would |

## Returns

### 200 OK

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `workflow_id` | string | Yes |  |
| `region` | string (besg \| usnv) | Yes |  |
| `version` | object (WorkflowVersionSummary) | Yes | A version without its document; step_ids lists its steps (workflow_module_instance_id) |
| `version.workflow_version` | string | Yes |  |
| `version.is_draft` | boolean | Yes |  |
| `version.is_deployed` | boolean | Yes |  |
| `version.last_modified_time` | string | Yes |  |
| `version.step_ids` | array of string | Yes |  |
| `triggers` | array of object (StepTrigger) | Yes |  |
| `triggers[].step_id` | string | Yes |  |
| `triggers[].status` | string (succeeded \| failed) | Yes | Whether what a step runs alongside the workflow (schedule, email route, Gmail watch, queue consumer...) is set up |
| `triggers[].msg` | string \| null | No |  |

### 204 No Content

No body.

## Example request

```bash
curl -X PATCH "https://api.stacksync.com/v1/workspaces/{workspace_id}/workflows/{workflow_id}/draft?region=besg" \
  -H "Authorization: Bearer $STACKSYNC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "document": {
    "edges": [
      {
        "edge_id": "input-wait_5_seconds",
        "source": {
          "workflow_module_instance_id": "input"
        },
        "target": {
          "workflow_module_instance_id": "wait_5_seconds"
        }
      }
    ],
    "modules": [
      {
        "module_id": "system-input-1",
        "name": "Input",
        "properties": {},
        "workflow_module_instance_id": "input"
      },
      {
        "module_id": "system-wait-1",
        "name": "Wait 5 seconds",
        "properties": {
          "wait_for": 5
        },
        "workflow_module_instance_id": "wait_5_seconds"
      }
    ]
  }
}'
```

## Example response (200)

```json
{
  "workflow_id": "<workflow_id>",
  "region": "besg",
  "version": {
    "workflow_version": "<workflow_version>",
    "is_draft": false,
    "is_deployed": false,
    "last_modified_time": "<last_modified_time>",
    "step_ids": [
      "<step_ids>"
    ]
  },
  "triggers": [
    {
      "step_id": "<step_id>",
      "status": "succeeded",
      "msg": "<msg>"
    }
  ]
}
```

## Errors

| Status | Meaning | Body |
| --- | --- | --- |
| 400 | Bad Request | `{ "error": string, "msg": string, "field": string \| null }` |
| 403 | Forbidden | `{ "error": string, "msg": string, "field": string \| null }` |
| 404 | Not Found | `{ "error": string, "msg": string, "field": string \| null }` |
| 409 | Conflict | `{ "error": string, "msg": string, "field": string \| null }` |

## Related

- [API Reference overview](https://docs.stacksync.com/api-reference): base URLs, regions, pagination, idempotency and errors
- [Authentication](https://docs.stacksync.com/api-reference/authentication): API keys and the 403 answers
- OpenAPI document: https://docs.stacksync.com/openapi.json
- [List workflows](https://docs.stacksync.com/api-reference/workflows/list_workflows)
- [List workflow versions](https://docs.stacksync.com/api-reference/workflows/list_workflow_versions)
- [Get workflow](https://docs.stacksync.com/api-reference/workflows/get_workflow)
- [Get workflow info](https://docs.stacksync.com/api-reference/workflows/get_workflow_info)
- [Create workflow](https://docs.stacksync.com/api-reference/workflows/create_workflow)
- [Create workflow draft](https://docs.stacksync.com/api-reference/workflows/create_workflow_draft)
- [Update workflow](https://docs.stacksync.com/api-reference/workflows/update_workflow)
- [Update workflow options](https://docs.stacksync.com/api-reference/workflows/update_workflow_options)
- [Delete workflow](https://docs.stacksync.com/api-reference/workflows/delete_workflow)
- [Run workflow](https://docs.stacksync.com/api-reference/workflows/run_workflow)
- [Deploy workflow](https://docs.stacksync.com/api-reference/workflows/deploy_workflow)
- [Duplicate workflow](https://docs.stacksync.com/api-reference/workflows/duplicate_workflow)
- [Check a workflow email alias](https://docs.stacksync.com/api-reference/workflows/check_workflow_email_alias)