Update Workspace

Rename the workspace or change its slug

Updated Aug 11, 2026

Update the active workspace. POST is accepted as an alias for PATCH.

Endpoint#

https://api.orshot.com/v1/workspace

Request Body#

Parameter	Type	Required	Description
`title`	String	No	New display name, 1 to 100 characters
`slug`	String	No	New URL slug: lowercase letters, numbers and hyphens, 3 to 48 characters, unique across Orshot

Changing the slug changes all of the workspace's URLs. Reserved slugs (like admin or api) are rejected with code slug_reserved.

Request#

await fetch("https://api.orshot.com/v1/workspace", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
  body: JSON.stringify({
    title: "Acme Marketing",
  }),
});

Errors#

Status	Code	Description
`400`	`unknown_fields`	The request included fields outside the list above
`400`	`slug_reserved`	The requested slug is reserved
`400`		The slug is already taken or a value is invalid

Ready to automate?

Start rendering images, PDFs and videos from your templates in under 2 minutes. Free plan, no credit card.

Get your API key

Image, PDF and video generation via API
Visual editor with AI and smart layouts
Zapier, Make, MCP and 50+ integrations
White-label embed for your own app
30 free credits — no credit card required