Create Campaign Restriction

Endpoint to create a campaign restriction.

POST /public/v1/campaign-service/campaigns/{campaign-id}/restrictions

Create Campaign Restriction

cURL

curl --request POST \
  --url https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign-id}/restrictions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "restrictionTypeId": 123,
  "limit": 123
}
'

201

{
  "id": 123,
  "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "marketplaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "restrictionType": {
    "id": 123
  },
  "limit": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

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.

Path Parameters

campaign-id · string<uuid> · required

The ID of the campaign.

Body

application/json

Limit-based restrictions for a campaign.

restrictionTypeId · integer · required

The type of restriction.

limit · integer · required

The limit of the restriction.

Response

201

application/json

Successful Response

Limit-based restrictions for a campaign.

id · integer · required

The ID of the restriction.

campaignId · string<uuid> · required

The ID of the campaign.

marketplaceId · string<uuid> · required

The ID of the marketplace.

restrictionType · RestrictionTypeResponse · object · required

The type of restriction.

Show child attributes

limit · integer · required

The limit of the restriction.

createdAt · string<date-time> · required

The creation date of the restriction.

updatedAt · string<date-time> · required

The last update date of the restriction.

status · enum<string> · required

The status of the restriction.

Available options: active, inactive