# workflows

A **workflow** is an automated process that connects your spreadsheets and files and moves data between them — on a schedule or on demand — so a task that would otherwise be manual runs by itself. It is the top-level container that holds automations, forms and triggers.

Use these endpoints to **list, create, read, update, run and archive** workflows, and to inspect their combined **sources** and **destinations**.

Base URL: `https://dev-api.sheetgo.com`. Start page: https://dev-api.sheetgo.com/rest/reference.md

This page documents every endpoint of the group. Request and response shapes link to model pages; fetch the model pages an endpoint links before building a body.

Guide: [Rate Limiting](https://dev-api.sheetgo.com/rest/guides/rate-limiting.md)

Every endpoint is rate limited; see the guide [Rate Limiting](https://dev-api.sheetgo.com/rest/guides/rate-limiting.md).

<a id="post-rest-beta-workflows-run-id"></a>
## POST /rest/beta/workflows/run/{id}

**(Obsolete) Use /workflows/<id>/run instead**

Deprecated

This endpoint will be removed

Authentication, any one of: `default`; `Developer Access`; `sheetgo-api-key`.

**Parameters**

| Name | In | Type | Required | Description | Allowed values / default / constraints |
| --- | --- | --- | --- | --- | --- |
| `id` | path | string | yes | Workflow identification |  |

**Responses**

- `200` Workflow was successfully enqueued. Schema: [SuccessResponse](https://dev-api.sheetgo.com/rest/reference/models/SuccessResponse.md)
- `404` Not found
- `401` Authentication failed or token is invalid
- `422` Validation Error. Schema: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md)

Read next: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md), [SuccessResponse](https://dev-api.sheetgo.com/rest/reference/models/SuccessResponse.md).

<a id="get-rest-beta-workflows-id-run"></a>
## GET /rest/beta/workflows/{id}/run

**Get a workflow's last-run status**

Last-run execution status of the workflow, with a per-automation breakdown.

Reflects each automation's most recent execution (latest only — no history).

Authentication, any one of: `default`; `Developer Access`; `sheetgo-api-key`.

**Parameters**

| Name | In | Type | Required | Description | Allowed values / default / constraints |
| --- | --- | --- | --- | --- | --- |
| `id` | path | string | yes | Workflow identification |  |

**Responses**

- `200` Workflow last-run status. Schema: [WorkflowRunStatus](https://dev-api.sheetgo.com/rest/reference/models/WorkflowRunStatus.md)
- `404` Workflow not found
- `401` Authentication failed or token is invalid
- `422` Validation Error. Schema: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md)

Read next: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md), [WorkflowRunStatus](https://dev-api.sheetgo.com/rest/reference/models/WorkflowRunStatus.md).

<a id="post-rest-beta-workflows-id-run"></a>
## POST /rest/beta/workflows/{id}/run

**Run a single workflow**

Given a workflow id, the workflow will start its execution

Authentication, any one of: `default`; `Developer Access`; `sheetgo-api-key`.

**Parameters**

| Name | In | Type | Required | Description | Allowed values / default / constraints |
| --- | --- | --- | --- | --- | --- |
| `id` | path | string | yes | Workflow identification |  |

**Responses**

- `200` Workflow was successfully enqueued. Schema: [SuccessResponse](https://dev-api.sheetgo.com/rest/reference/models/SuccessResponse.md)
- `404` Not found
- `401` Authentication failed or token is invalid
- `422` Validation Error. Schema: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md)

Read next: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md), [SuccessResponse](https://dev-api.sheetgo.com/rest/reference/models/SuccessResponse.md).

<a id="get-rest-beta-workflows-id-files"></a>
## GET /rest/beta/workflows/{id}/files

**Get file sources and destinations of all automations in a workflow**

Return the sources and destinations of each automation in a workflow.

Every source type is included (file, folder, api, webhook, integration,
bigquery, outlook); write-only fields such as an api source's headers
are omitted.

Destinations include generated-document and PDF destinations, which are
backed by a Drive folder (and, for documents, the Docs template).

Authentication, any one of: `default`; `Developer Access`; `sheetgo-api-key`.

**Parameters**

| Name | In | Type | Required | Description | Allowed values / default / constraints |
| --- | --- | --- | --- | --- | --- |
| `id` | path | string | yes | Workflow identification |  |

**Responses**

- `200` File sources and destinations per automation
- `404` Not found
- `401` Authentication failed or token is invalid
- `422` Validation Error. Schema: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md)

Read next: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md).

<a id="get-rest-beta-workflows-id-sources"></a>
## GET /rest/beta/workflows/{id}/sources

**Get file sources of all automations in a workflow**

Return the sources of each automation in a workflow.

Every source type is included (file, folder, api, webhook, integration,
bigquery, outlook); write-only fields such as an api source's headers
are omitted.

Authentication, any one of: `default`; `Developer Access`; `sheetgo-api-key`.

**Parameters**

| Name | In | Type | Required | Description | Allowed values / default / constraints |
| --- | --- | --- | --- | --- | --- |
| `id` | path | string | yes | Workflow identification |  |

**Responses**

- `200` File sources per automation
- `404` Not found
- `401` Authentication failed or token is invalid
- `422` Validation Error. Schema: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md)

Read next: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md).

<a id="get-rest-beta-workflows-id-destinations"></a>
## GET /rest/beta/workflows/{id}/destinations

**Get file destinations of all automations in a workflow**

Return the file/folder destinations of each automation in a workflow.

Destinations include generated-document and PDF destinations, which are
backed by a Drive folder (and, for documents, the Docs template).

Authentication, any one of: `default`; `Developer Access`; `sheetgo-api-key`.

**Parameters**

| Name | In | Type | Required | Description | Allowed values / default / constraints |
| --- | --- | --- | --- | --- | --- |
| `id` | path | string | yes | Workflow identification |  |

**Responses**

- `200` File destinations per automation
- `404` Not found
- `401` Authentication failed or token is invalid
- `422` Validation Error. Schema: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md)

Read next: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md).

<a id="get-rest-beta-workflows-id"></a>
## GET /rest/beta/workflows/{id}

**Get a single workflow**

Given a workflow id, returns the workflow model data

Authentication, any one of: `default`; `Developer Access`; `sheetgo-api-key`.

**Parameters**

| Name | In | Type | Required | Description | Allowed values / default / constraints |
| --- | --- | --- | --- | --- | --- |
| `id` | path | string | yes | Workflow identification |  |

**Responses**

- `200` The workflow model data. Schema: [WorkflowModel](https://dev-api.sheetgo.com/rest/reference/models/WorkflowModel.md)
- `404` Not found
- `401` Authentication failed or token is invalid
- `422` Validation Error. Schema: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md)

Read next: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md), [WorkflowModel](https://dev-api.sheetgo.com/rest/reference/models/WorkflowModel.md).

<a id="patch-rest-beta-workflows-id"></a>
## PATCH /rest/beta/workflows/{id}

**Update an existing workflow**

Updates a workflow identified by id with the given arguments

Authentication, any one of: `default`; `Developer Access`; `sheetgo-api-key`.

**Parameters**

| Name | In | Type | Required | Description | Allowed values / default / constraints |
| --- | --- | --- | --- | --- | --- |
| `id` | path | string | yes | Workflow identification |  |

**Request body**

Content type `application/json`. Optional.

Body: [WorkflowPatch](https://dev-api.sheetgo.com/rest/reference/models/WorkflowPatch.md)

**Responses**

- `200` The workflow model updated. Schema: [WorkflowModel](https://dev-api.sheetgo.com/rest/reference/models/WorkflowModel.md)
- `404` Not found
- `401` Authentication failed or token is invalid
- `422` Validation Error. Schema: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md)

Read next: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md), [WorkflowModel](https://dev-api.sheetgo.com/rest/reference/models/WorkflowModel.md), [WorkflowPatch](https://dev-api.sheetgo.com/rest/reference/models/WorkflowPatch.md).

<a id="delete-rest-beta-workflows-id"></a>
## DELETE /rest/beta/workflows/{id}

**Archive a workflow**

Given a workflow id, archive the workflow

Authentication, any one of: `default`; `Developer Access`; `sheetgo-api-key`.

**Parameters**

| Name | In | Type | Required | Description | Allowed values / default / constraints |
| --- | --- | --- | --- | --- | --- |
| `id` | path | string | yes | Workflow identification |  |

**Request body**

Content type `application/json`. Required.

Body: [WorkflowArchive](https://dev-api.sheetgo.com/rest/reference/models/WorkflowArchive.md)

**Responses**

- `200` The workflow was successfully archived. Schema: [SuccessResponse](https://dev-api.sheetgo.com/rest/reference/models/SuccessResponse.md)
- `404` Not found
- `401` Authentication failed or token is invalid
- `422` Validation Error. Schema: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md)

Read next: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md), [SuccessResponse](https://dev-api.sheetgo.com/rest/reference/models/SuccessResponse.md), [WorkflowArchive](https://dev-api.sheetgo.com/rest/reference/models/WorkflowArchive.md).

<a id="get-rest-beta-workflows"></a>
## GET /rest/beta/workflows/

**Get a paginated list of workflows**

Return a list of workflows following the pagination parameters

Authentication, any one of: `default`; `Developer Access`; `sheetgo-api-key`.

**Parameters**

| Name | In | Type | Required | Description | Allowed values / default / constraints |
| --- | --- | --- | --- | --- | --- |
| `page` | query | integer | no | Page number, 1-based | default: `1`; min: 1 |
| `per_page` | query | integer | no | Number of items per page (1-100; values above 100 are clamped to 100 and the effective size is echoed in the response) | default: `50`; min: 1 |

**Responses**

- `200` A paginated list of workflows. Schema: [PaginatedResponse_WorkflowModel_](https://dev-api.sheetgo.com/rest/reference/models/PaginatedResponse_WorkflowModel_.md)
- `404` Not found
- `401` Authentication failed or token is invalid
- `422` Validation Error. Schema: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md)

Read next: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md), [PaginatedResponse_WorkflowModel_](https://dev-api.sheetgo.com/rest/reference/models/PaginatedResponse_WorkflowModel_.md).

<a id="post-rest-beta-workflows"></a>
## POST /rest/beta/workflows/

**Create a new workflow**

Create a new workflow with the given arguments

Authentication, any one of: `default`; `Developer Access`; `sheetgo-api-key`.

**Request body**

Content type `application/json`. Optional.

Body: [WorkflowCreate](https://dev-api.sheetgo.com/rest/reference/models/WorkflowCreate.md)

**Responses**

- `200` The workflow model created. Schema: [WorkflowModel](https://dev-api.sheetgo.com/rest/reference/models/WorkflowModel.md)
- `404` Not found
- `401` Authentication failed or token is invalid
- `422` Validation Error. Schema: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md)

Read next: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md), [WorkflowCreate](https://dev-api.sheetgo.com/rest/reference/models/WorkflowCreate.md), [WorkflowModel](https://dev-api.sheetgo.com/rest/reference/models/WorkflowModel.md).

<a id="get-rest-beta-workflows-id-collaborators"></a>
## GET /rest/beta/workflows/{id}/collaborators

**List a workflow's collaborators**

Members and their roles (owner included).

Authentication, any one of: `default`; `Developer Access`; `sheetgo-api-key`.

**Parameters**

| Name | In | Type | Required | Description | Allowed values / default / constraints |
| --- | --- | --- | --- | --- | --- |
| `id` | path | string | yes | Workflow identification |  |

**Responses**

- `200` Workflow collaborators. Schema: [CollaboratorsOut](https://dev-api.sheetgo.com/rest/reference/models/CollaboratorsOut.md)
- `404` Workflow not found
- `401` Authentication failed or token is invalid
- `422` Validation Error. Schema: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md)

Read next: [CollaboratorsOut](https://dev-api.sheetgo.com/rest/reference/models/CollaboratorsOut.md), [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md).

<a id="post-rest-beta-workflows-id-collaborators"></a>
## POST /rest/beta/workflows/{id}/collaborators

**Add collaborators to a workflow**

Invite one or more collaborators. Sends an invitation email unless skip_invitation.

Authentication, any one of: `default`; `Developer Access`; `sheetgo-api-key`.

**Parameters**

| Name | In | Type | Required | Description | Allowed values / default / constraints |
| --- | --- | --- | --- | --- | --- |
| `id` | path | string | yes | Workflow identification |  |

**Request body**

Content type `application/json`. Required.

Body: [CollaboratorsAdd](https://dev-api.sheetgo.com/rest/reference/models/CollaboratorsAdd.md)

**Responses**

- `200` Updated collaborators. Schema: [CollaboratorsOut](https://dev-api.sheetgo.com/rest/reference/models/CollaboratorsOut.md)
- `404` Not found
- `401` Authentication failed or token is invalid
- `403` Permission or plan restriction
- `409` Collaborator limit reached
- `429` Daily invitation limit reached
- `422` Validation Error. Schema: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md)

Read next: [CollaboratorsAdd](https://dev-api.sheetgo.com/rest/reference/models/CollaboratorsAdd.md), [CollaboratorsOut](https://dev-api.sheetgo.com/rest/reference/models/CollaboratorsOut.md), [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md).

<a id="delete-rest-beta-workflows-id-collaborators"></a>
## DELETE /rest/beta/workflows/{id}/collaborators

**Remove all collaborators from a workflow**

Remove every collaborator at once. The owner is always kept.

Reports per-email outcomes; a partial failure does not abort the rest. Does not
change general (domain/team) access - use DELETE /general-access for that.

Authentication, any one of: `default`; `Developer Access`; `sheetgo-api-key`.

**Parameters**

| Name | In | Type | Required | Description | Allowed values / default / constraints |
| --- | --- | --- | --- | --- | --- |
| `id` | path | string | yes | Workflow identification |  |
| `confirm` | query | boolean | no | Must be true - removes every collaborator | default: `false` |
| `remove_file_access` | query | boolean | no | Also revoke their access to the files | default: `false` |

**Responses**

- `200` Collaborators removed (owner kept)
- `404` Not found
- `401` Authentication failed or token is invalid
- `400` Missing confirmation
- `403` Permission restriction
- `422` Validation Error. Schema: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md)

Read next: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md).

<a id="patch-rest-beta-workflows-id-collaborators-email"></a>
## PATCH /rest/beta/workflows/{id}/collaborators/{email}

**Change a collaborator's role**

Promote or demote a collaborator (manager | collaborator).

Authentication, any one of: `default`; `Developer Access`; `sheetgo-api-key`.

**Parameters**

| Name | In | Type | Required | Description | Allowed values / default / constraints |
| --- | --- | --- | --- | --- | --- |
| `id` | path | string | yes | Workflow identification |  |
| `email` | path | string | yes | Collaborator email |  |

**Request body**

Content type `application/json`. Required.

Body: [CollaboratorRoleUpdate](https://dev-api.sheetgo.com/rest/reference/models/CollaboratorRoleUpdate.md)

**Responses**

- `200` Updated collaborators. Schema: [CollaboratorsOut](https://dev-api.sheetgo.com/rest/reference/models/CollaboratorsOut.md)
- `404` Workflow or member not found
- `401` Authentication failed or token is invalid
- `422` Validation Error. Schema: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md)

Read next: [CollaboratorRoleUpdate](https://dev-api.sheetgo.com/rest/reference/models/CollaboratorRoleUpdate.md), [CollaboratorsOut](https://dev-api.sheetgo.com/rest/reference/models/CollaboratorsOut.md), [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md).

<a id="delete-rest-beta-workflows-id-collaborators-email"></a>
## DELETE /rest/beta/workflows/{id}/collaborators/{email}

**Remove a collaborator**

Remove a collaborator, optionally revoking their file permissions.

Authentication, any one of: `default`; `Developer Access`; `sheetgo-api-key`.

**Parameters**

| Name | In | Type | Required | Description | Allowed values / default / constraints |
| --- | --- | --- | --- | --- | --- |
| `id` | path | string | yes | Workflow identification |  |
| `email` | path | string | yes | Collaborator email |  |
| `remove_file_access` | query | boolean | no | Also revoke their access to the files | default: `false` |

**Responses**

- `200` Updated collaborators. Schema: [CollaboratorsOut](https://dev-api.sheetgo.com/rest/reference/models/CollaboratorsOut.md)
- `404` Workflow or member not found
- `401` Authentication failed or token is invalid
- `409` The owner cannot be removed
- `422` Validation Error. Schema: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md)

Read next: [CollaboratorsOut](https://dev-api.sheetgo.com/rest/reference/models/CollaboratorsOut.md), [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md).

<a id="get-rest-beta-workflows-id-general-access"></a>
## GET /rest/beta/workflows/{id}/general-access

**Get a workflow's general (domain/team) access**

Whether the workflow is restricted, domain-wide, or team-wide.

Authentication, any one of: `default`; `Developer Access`; `sheetgo-api-key`.

**Parameters**

| Name | In | Type | Required | Description | Allowed values / default / constraints |
| --- | --- | --- | --- | --- | --- |
| `id` | path | string | yes | Workflow identification |  |

**Responses**

- `200` Domain/team access. Schema: [GeneralAccessOut](https://dev-api.sheetgo.com/rest/reference/models/GeneralAccessOut.md)
- `404` Not found
- `401` Authentication failed or token is invalid
- `422` Validation Error. Schema: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md)

Read next: [GeneralAccessOut](https://dev-api.sheetgo.com/rest/reference/models/GeneralAccessOut.md), [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md).

<a id="put-rest-beta-workflows-id-general-access"></a>
## PUT /rest/beta/workflows/{id}/general-access

**Set a workflow's general (domain/team) access**

restrict clears domain/team; domain/team are derived from the owner's account.

Authentication, any one of: `default`; `Developer Access`; `sheetgo-api-key`.

**Parameters**

| Name | In | Type | Required | Description | Allowed values / default / constraints |
| --- | --- | --- | --- | --- | --- |
| `id` | path | string | yes | Workflow identification |  |

**Request body**

Content type `application/json`. Required.

Body: [GeneralAccessSet](https://dev-api.sheetgo.com/rest/reference/models/GeneralAccessSet.md)

**Responses**

- `200` Updated access. Schema: [GeneralAccessOut](https://dev-api.sheetgo.com/rest/reference/models/GeneralAccessOut.md)
- `404` Not found
- `401` Authentication failed or token is invalid
- `403` Permission or plan restriction
- `422` Validation Error. Schema: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md)

Read next: [GeneralAccessOut](https://dev-api.sheetgo.com/rest/reference/models/GeneralAccessOut.md), [GeneralAccessSet](https://dev-api.sheetgo.com/rest/reference/models/GeneralAccessSet.md), [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md).

<a id="delete-rest-beta-workflows-id-general-access"></a>
## DELETE /rest/beta/workflows/{id}/general-access

**Revoke a workflow's general (domain/team) access**

Reset general access to `restrict` - the same as PUT {"access_type": "restrict"}.

Note: because scopes derive from the HTTP method, this requires workflows.delete
while the equivalent PUT requires workflows.write.

Authentication, any one of: `default`; `Developer Access`; `sheetgo-api-key`.

**Parameters**

| Name | In | Type | Required | Description | Allowed values / default / constraints |
| --- | --- | --- | --- | --- | --- |
| `id` | path | string | yes | Workflow identification |  |

**Responses**

- `200` General access reset to restrict. Schema: [GeneralAccessOut](https://dev-api.sheetgo.com/rest/reference/models/GeneralAccessOut.md)
- `404` Not found
- `401` Authentication failed or token is invalid
- `403` Permission restriction
- `422` Validation Error. Schema: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md)

Read next: [GeneralAccessOut](https://dev-api.sheetgo.com/rest/reference/models/GeneralAccessOut.md), [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md).

<a id="post-rest-beta-workflows-id-leave"></a>
## POST /rest/beta/workflows/{id}/leave

**Leave a shared workflow**

Remove yourself from a workflow shared with you.

Authentication, any one of: `default`; `Developer Access`; `sheetgo-api-key`.

**Parameters**

| Name | In | Type | Required | Description | Allowed values / default / constraints |
| --- | --- | --- | --- | --- | --- |
| `id` | path | string | yes | Workflow identification |  |

**Responses**

- `200` You left the workflow
- `404` Not found
- `401` Authentication failed or token is invalid
- `409` The owner cannot leave
- `422` Validation Error. Schema: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md)

Read next: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md).

<a id="post-rest-beta-workflows-id-request-access"></a>
## POST /rest/beta/workflows/{id}/request-access

**Ask a workflow's owner for access**

Email the owner an access request. Approval happens in the Sheetgo app.

Authentication, any one of: `default`; `Developer Access`; `sheetgo-api-key`.

**Parameters**

| Name | In | Type | Required | Description | Allowed values / default / constraints |
| --- | --- | --- | --- | --- | --- |
| `id` | path | string | yes | Workflow identification |  |

**Responses**

- `202` Access request sent to the owner
- `404` Workflow not found
- `401` Authentication failed or token is invalid
- `422` Validation Error. Schema: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md)

Read next: [HTTPValidationError](https://dev-api.sheetgo.com/rest/reference/models/HTTPValidationError.md).

<a id="post-rest-beta-workflows-id-change-owner"></a>
## POST /rest/beta/workflows/{id}/change-owner

**Transfer workflow ownership**

Transfer ownership to another Sheetgo user. Owner only; irreversible.

Authentication, any one of: `default`; `Developer Access`; `sheetgo-api-key`.

**Parameters**

| Name | In | Type | Required | Description | Allowed values / default / constraints |
| --- | --- | --- | --- | --- | --- |
| `id` | path | string | yes | Workflow identification |  |
| `confirm` | query | boolean | no | Must be true - this cannot be undone | default: `false` |

**Request body**

Content type `application/json`. Required.

Body: [ChangeOwnerIn](https://dev-api.sheetgo.com/rest/reference/models/ChangeOwnerIn.md)

**Responses**

- `200` Ownership transferred
- `404` Not found
- `401` Authentication failed or token is invalid
- `400` Missing confirmation
- `403` Only the owner can transfer ownership
- `422` The new owner is not a Sheetgo user

Read next: [ChangeOwnerIn](https://dev-api.sheetgo.com/rest/reference/models/ChangeOwnerIn.md).

---

More: start page https://dev-api.sheetgo.com/rest/reference.md, everything in one file https://dev-api.sheetgo.com/rest/llms-full.txt, OpenAPI https://dev-api.sheetgo.com/rest/openapi.json.