Passer au contenu principal
POST
Create Slot

Autorisations

Authorization
string
header
requis

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.

Corps

application/json

Category or search slot create request.

slotId
string
requis

The unique external slot ID that represents the slot.

Minimum string length: 1
Pattern: ^[\w!\"#$%&'()*+,\-._/:;<>?@\[\]^\{\}~=\\]*$
Exemple:

"sidebar-2"

dimensions
SlotCreateRequestDimensions · object
requis

The dimensions of the slot per device type.

position
enum<string>
requis
Options disponibles:
category,
search

Réponse

Successful Response

The ad config slot model.

id
string<uuid>
requis

The ID of the ad config slot.

externalId
string
requis

The external ID provided by marketplaces.

Minimum string length: 1
position
enum<string>
requis

The position of the ad config slot.

Options disponibles:
landing,
category_search,
category,
search
marketplaceId
string<uuid>
requis

The ID of the marketplace that the ad config slot belongs to.

dimensions
Dimensions · object
requis

The slot dimensions. There can be at most one dimension for each device type.

Exemple:
page
AdConfigPage · object | null

The page that the ad config slot belongs to. Only 'landing' slots can belong to a page.

isActive
boolean
défaut:true

Indicates whether the ad config slot is active. If false, the slot cannot be used in campaigns.