Create ColorCollection

Version 3.1.23.16

Create a custom color collection with the specified information

Creates a new custom color collection object, returning the details, including the created id.

Update an existing color collection with Update Color Collection

Permanently delete an existing custom color collection with Delete Color Collection

Note: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return Not Found (404) errors.

Request

POST /color_collections
Datatype
Description
Request
HTTP Request
body
HTTP Body
Expand HTTP Body definition...
body
ColorCollection
Expand ColorCollection definition...
id
string
Unique Id
label
string
Label of color collection
categoricalPalettes
sequentialPalettes
divergingPalettes

Response

200: ColorCollection

Datatype
Description
(object)
id
string
Unique Id
label
string
Label of color collection
categoricalPalettes
Expand DiscretePalette definition...
id
string
Unique identity string
label
string
Label for palette
type
string
Type of palette
colors
string[]
sequentialPalettes
Expand ContinuousPalette definition...
id
string
Unique identity string
label
string
Label for palette
type
string
Type of palette
stops
Expand ColorStop definition...
color
string
CSS color string
offset
integer
Offset in continuous palette (0 to 100)
divergingPalettes
Expand ContinuousPalette definition...
id
string
Unique identity string
label
string
Label for palette
type
string
Type of palette
stops
Expand ColorStop definition...
color
string
CSS color string
offset
integer
Offset in continuous palette (0 to 100)

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

403: Permission Denied

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

409: Resource Already Exists

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

422: Validation Error

Datatype
Description
(object)
message
string
Error details
Expand ValidationErrorDetail definition...
field
string
Field with error
code
string
Error code
message
string
Error info message
documentation_url
string
Documentation link
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link