Skip to main content
POST
Create a placement catalog

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Schema for creating a placement catalog.

created_by
string<uuid>
required

The ID of the user who created the placement catalog

description
string
required

The description in JSON Quill Delta format - a JSON format that represents rich text content
Links: https://quilljs.com/docs/delta

name
string
required

The name of the placement catalog

placement_ids
string[]
required

The list of placement IDs

settings
PlacementCatalogSettingSchema · object
required

Schema for placement catalog settings.

created_at
string<date-time> | null

The date and time the entity was created.

updated_at
string<date-time> | null

The date and time the entity was last updated.

Response

Successful Response

Schema for reading a placement catalog.

created_by
string<uuid>
required

The ID of the user who created the placement catalog

description
string
required

The description in JSON Quill Delta format - a JSON format that represents rich text content
Links: https://quilljs.com/docs/delta

id
string<uuid>
required
name
string
required

The name of the placement catalog

no
integer
required
placement_ids
string[]
required

The list of placement IDs

settings
PlacementCatalogSettingSchema · object
required

Schema for placement catalog settings.

created_at
string<date-time> | null

The date and time the entity was created.

updated_at
string<date-time> | null

The date and time the entity was last updated.