Media API

Create Slot

Create a new slot.

post/public/v1/media-service/slots

Request

  • Base URL: https://api.topsort.com
  • URL: https://api.topsort.com/public/v1/media-service/slots
  • Auth: HTTP bearer

Request body

OR

Example request

{
  "slotId": "sidebar-2"
}

Response

Successful Response

idstring uuid required

The ID of the ad config slot.

externalIdstring required

The external ID provided by marketplaces.

position'landing' | 'category_search' | 'category' | 'search' required
marketplaceIdstring uuid required

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

dimensionsobject required

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

isActiveboolean

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

Example response

{
  "page": {
    "name": "Homepage",
    "url": "https://app.example.com/main"
  },
  "dimensions": {
    "desktop": {
      "height": 20,
      "width": 20
    },
    "mobile": {
      "height": 10,
      "width": 10
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.