Add Color

Learn how to save brand colors to your workspace

Overview#

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

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

Request#

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
  }),
});

Request Parameters#

Parameter	Type	Required	Description
`value`	String	Yes	The color value (e.g., `#FF5733`, `rgb(255, 87, 51)`, or a CSS gradient)
`type`	String	No	Color type: `hex`, `rgb`, `hsl`, or `gradient`. Defaults to `hex`
`tags`	String[]	No	Array of tags to associate with the color (e.g., `["primary", "brand"]`)