Update Workflow Sharing

Overview#

Turn public sharing on or off for a workflow. Sharing publishes the workflow to a public page anyone can view and copy into their own workspace.

The share link is minted once and stays stable: turning sharing off and back on brings the same link back to life, so anything you already shared keeps working.

https://api.orshot.com/v1/workflows/:id/share

Path Parameters#

Request Body#

Both fields are optional. A field you leave out keeps its current value, so you can flip includeTemplate without touching the sharing state.

Request#

await fetch("https://api.orshot.com/v1/workflows/83/share", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
  body: JSON.stringify({
    enabled: true,
    includeTemplate: true, // Optional
  }),
});

Error Responses#

Workflow Not Found (404)#

{
  "error": "Not found"
}

Failed to Update (500)#

{
  "error": "Failed to update sharing"
}

Notes#

• Disabling sharing makes the public page return a 404, but keeps the slug. Re-enabling restores the exact same URLs.
• Sharing state cannot be set through the general workflow update endpoint; this endpoint is the only way to change it.

Rate Limits#

• 60 requests per minute per workspace