Workflows

Share Workflow

Shares the workflow with members of your organization and stops sharing it with others, in one call. Sharing a workflow gives edit access, and it appears in their workflow list.

Only the workflow's owner and org admins can do this. People in add who already have it, and the owner, are reported in data.skipped; people in remove who did not have it are ignored. Read the current list from Get Workflow Overview (shared_users).

A refusal changes nothing; its code says why, and emails lists any refused addresses.

patch/api/v1/workflows/{workflow_id}/shares

Request

  • Base URL
    http://localhost:3009
  • Auth
    HTTP bearer

Path parameters

workflow_idstring required

Workflow ID.

Request body

addstring[]

Email addresses to share with. They must be current members of your organization.

removestring[]

Email addresses to stop sharing with. Former members can be removed too.

Example request

{
  "add": [
    "sam@acme.com"
  ],
  "remove": [
    "kim@acme.com"
  ]
}

Response

Default Response

statusinteger
messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.