Delete Color

Learn how to delete a saved brand color from your workspace

Published

DELETE
/v1/brand-assets/colors/delete/{id}
curl -X DELETE "https://api.orshot.com/v1/brand-assets/colors/delete/<ID>" \
  -H "Authorization: Bearer <ORSHOT_API_KEY>"

Overview#

This endpoint allows you to delete a specific brand color from your workspace using its unique ID.

Endpoint
https://api.orshot.com/v1/brand-assets/colors/delete/:id

Request#

JavaScript
await fetch("https://api.orshot.com/v1/brand-assets/colors/delete/123", {
  method: "DELETE",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
});
JSON
{
  "message": "Color successfully deleted",
  "id": "123"
}

Path Parameters#

ParameterTypeRequiredDescription
idNumberYesThe unique identifier of the color to delete

Error Responses#

Color Not Found (404)#

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

Missing Color ID (400)#

JSON
{
  "error": "Color ID is required"
}

Unauthorized (403)#

JSON
{
  "error": "Access Forbidden"
}

Notes#

  • The color must belong to your workspace
  • Once deleted, colors cannot be recovered

Query Parameters#

ParameterTypeRequiredDescription
embedIdStringNoEmbed instance ID. Pair with embedUserId to scope this call to one embed user
embedUserIdStringNoThe same userId your app passes to the embed URL. Requires embedId

Per-User Libraries#

Pass embedId and embedUserId together to target only that embed user's color, so one user's ID can never delete another's. This is how one embed serves many brands or tenants, each with its own brand space.

Omit them and this endpoint behaves exactly as documented above. See Per-User Brand Assets for the full picture.

Rate Limits#

  • 30 requests per minute per endpoint
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
  • 100 free credits a month, no credit card required