Add Color

Learn how to save brand colors to your workspace

Published ·Updated

POST
/v1/brand-assets/colors/add
curl -X POST "https://api.orshot.com/v1/brand-assets/colors/add" \
  -H "Authorization: Bearer <ORSHOT_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "value": "<VALUE>",
    "type": "<TYPE>",
    "tags": []
  }'

Overview#

This endpoint allows you to save a new brand color to your workspace. Supports hex, RGB, HSL, and gradient color values.

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

Request#

JavaScript
await fetch("https://api.orshot.com/v1/brand-assets/colors/add", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
  body: JSON.stringify({
    type: "hex",
    value: "#FF5733",
    tags: ["primary", "brand"], // optional
  }),
});
JavaScript
await fetch("https://api.orshot.com/v1/brand-assets/colors/add", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
  body: JSON.stringify({
    type: "gradient",
    value: "linear-gradient(135deg, #667eea 0%, #764ba2 100%)",
    tags: ["gradient", "hero"], // optional
  }),
});
JSON
{
  "data": {
    "id": 125,
    "created_at": "2025-09-11T10:15:30.123Z",
    "type": "hex",
    "value": "#FF5733",
    "workspace_id": 50,
    "user_id": "abcdef01-2345-6789-abcd-ef0123456789"
  }
}

Request Parameters#

ParameterTypeRequiredDescription
valueStringYesThe color value (e.g., #FF5733, rgb(255, 87, 51), or a CSS gradient)
typeStringNoColor type: hex, rgb, hsl, or gradient. Defaults to hex
tagsString[]NoArray of tags to associate with the color (e.g., ["primary", "brand"])

Supported Color Types#

TypeExample Value
hex#FF5733, #FFF, #FF573380
rgbrgb(255, 87, 51)
hslhsl(11, 100%, 60%)
gradientlinear-gradient(135deg, #667eea 0%, #764ba2 100%)

Notes#

  • Hex colors are validated for correct format (#RGB, #RRGGBB, or #RRGGBBAA)
  • The list endpoint returns the 200 most recently added colors

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 save the color into that embed user's private palette instead of the shared workspace palette. 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