OMomniapp
Color Palettes

Update a custom color palette

Changed on

Updates a custom chart color palette. Omitted fields keep their current values. Charts using the palette pick up the new colors. Requires the Manage Config permission.

put/api/v1/color-palettes/{id}

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/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

Palette ID

Example:3c90c3cc-0d44-4b50-8888-8dd25736052a

Request body

colorsstring[]

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

namestring

Palette name, unique per type within the organization

type'discrete' | 'continuous'

'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 updated

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