Rename Template Folder

Rename a template folder in your workspace

Published

PATCH
/v1/studio/folders/{folderId}
curl -X PATCH "https://api.orshot.com/v1/studio/folders/<FOLDER_ID>" \
  -H "Authorization: Bearer <ORSHOT_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "<NAME>"
  }'

Overview#

Rename an existing template folder.

Endpoint
https://api.orshot.com/v1/studio/folders/:folderId

Path Parameters#

ParameterTypeRequiredDescription
folderIdIntegerYesThe unique ID of the folder

Request Body#

ParameterTypeRequiredDescription
nameStringYesNew folder name, up to 50 characters, unique per workspace

Request#

JavaScript
await fetch("https://api.orshot.com/v1/studio/folders/11", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
  body: JSON.stringify({
    name: "Instagram Posts",
  }),
});
JSON
{
  "folder": {
    "id": 11,
    "name": "Instagram Posts"
  }
}

Error Responses#

Folder Not Found (404)#

JSON
{
  "error": "Folder not found"
}

Duplicate Name (409)#

JSON
{
  "error": "A folder with this name already exists"
}

Invalid Name (400)#

JSON
{
  "error": "Folder name cannot be empty"
}

Rate Limits#

  • 30 requests per minute per API key
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 50+ integrations
  • White-label embed for your own app
  • 30 free credits — no credit card required