Color Palettes

Create a custom color palette

Changed on

Creates a custom chart color palette. Requires the Manage Config permission. Palette names must be unique per type within the organization.

post/api/v1/color-palettes

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/color-palettes
  • Auth
    HTTP bearer

Request body

colorsstring[] required

Ordered hex colors. Discrete palettes are used in order; continuous palettes interpolate between them.

namestring required

Palette name, unique per type within the organization

type'discrete' | 'continuous' required

'discrete' palettes color categories; 'continuous' palettes define a gradient for numeric scales

Example request

{
  "colors": [
    "#1f77b4",
    "#ff7f0e",
    "#2ca02c"
  ],
  "name": "Brand colors",
  "type": "discrete"
}

Response

Color palette created

colorsstring[] required

Ordered colors as stored, usually hex values

created_atstring date-time required

When the palette was created

idstring uuid required

Palette ID. Visualizations reference the palette by this value.

namestring required

Palette name

type'discrete' | 'continuous' required

'discrete' palettes color categories; 'continuous' palettes define a gradient for numeric scales

updated_atstring date-time required

When the palette was last updated

Example response

{
  "colors": [
    "#1f77b4",
    "#ff7f0e",
    "#2ca02c"
  ],
  "name": "Brand colors",
  "type": "discrete"
}

Changes