Update Workspace

Rename the workspace or change its slug

Updated

PATCH
/v1/workspace
curl -X PATCH "https://api.orshot.com/v1/workspace" \
  -H "Authorization: Bearer <ORSHOT_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "<TITLE>",
    "slug": "<SLUG>"
  }'

Update the workspace linked to your API key. POST is accepted as an alias for PATCH. Tokens from third-party OAuth apps are not accepted on this endpoint.

Endpoint#

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

Request Body#

ParameterTypeRequiredDescription
titleStringNoNew display name, 1 to 100 characters
slugStringNoNew 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#

JavaScript
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",
  }),
});
JSON
{
  "data": {
    "updated": ["title"],
    "title": "Acme Marketing",
    "slug": "my-workspace",
    "url": "https://orshot.com/workspace/my-workspace"
  }
}

Errors#

StatusCodeDescription
400unknown_fieldsThe request included fields outside the list above
400slug_reservedThe requested slug is reserved
409slug_takenThe slug is already used by another workspace
400A value is invalid, or the body has nothing to update
Was this page helpful?

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 40+ integrations
  • White-label embed for your own app
  • 100 free credits a month, no credit card required