Skip to main content
POST
Create a placement.

Authorizations

Authorization
string
header
required

A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.

Body

application/json

Placement configuration to create.

externalPlacementId
string
required

External identifier for the placement. Same value as slotId on public sponsored-brand campaigns.

Maximum string length: 255
Pattern: ^[A-Za-z0-9_-]+$
name
string
required

Name of the placement

Required string length: 5 - 50
jsonTemplateId
string<uuid>
required

The ID of the JSON template to use for the placement

logo
PublicPlacementLogo · object | null

Logo configuration

title
PublicPlacementTitle · object | null

Title configuration

products
PublicPlacementProducts · object

Products configuration

previewTemplate
PublicPlacementPreviewTemplate · object

Preview template configuration

Response

Successful Response

placementId
string<uuid>
required

Unique identifier for the placement

externalPlacementId
string
required

External identifier for the placement. Same value as slotId on public sponsored-brand campaigns.

Maximum string length: 255
Pattern: ^[A-Za-z0-9_-]+$
name
string
required

Name of the placement

Required string length: 5 - 50
products
Products · object
required

Products configuration

previewTemplate
PreviewTemplate · object
required

Preview template configuration

createdAt
string<date-time>
required

The time the placement was created

updatedAt
string<date-time>
required

The time the placement was last updated

logo
Logo · object | null

Logo configuration

title
Title · object | null

Title configuration

jsonTemplateId
string<uuid> | null

The ID of the JSON template used for the placement

jsonTemplate
JsonTemplate · object | null

The JSON template used for the placement