Passer au contenu principal
POST
/
public
/
v1
/
campaign-service
/
campaigns
/
{campaign-id}
/
restrictions
Create Campaign Restriction
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
}
'
import requests

url = "https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign-id}/restrictions"

payload = {
"restrictionTypeId": 123,
"limit": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({restrictionTypeId: 123, limit: 123})
};

fetch('https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign-id}/restrictions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign-id}/restrictions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'restrictionTypeId' => 123,
'limit' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign-id}/restrictions"

payload := strings.NewReader("{\n \"restrictionTypeId\": 123,\n \"limit\": 123\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign-id}/restrictions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"restrictionTypeId\": 123,\n \"limit\": 123\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign-id}/restrictions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"restrictionTypeId\": 123,\n \"limit\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "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"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

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.

Paramètres de chemin

campaign-id
string<uuid>
requis

The ID of the campaign.

Corps

application/json

Limit-based restrictions for a campaign.

restrictionTypeId
integer
requis

The type of restriction.

limit
integer
requis

The limit of the restriction.

Réponse

Successful Response

Limit-based restrictions for a campaign.

id
integer
requis

The ID of the restriction.

campaignId
string<uuid>
requis

The ID of the campaign.

marketplaceId
string<uuid>
requis

The ID of the marketplace.

restrictionType
RestrictionTypeResponse · object
requis

The type of restriction.

limit
integer
requis

The limit of the restriction.

createdAt
string<date-time>
requis

The creation date of the restriction.

updatedAt
string<date-time>
requis

The last update date of the restriction.

status
enum<string>
requis

The status of the restriction.

Options disponibles:
active,
inactive