Skip to main content
PUT
/
public
/
v1
/
campaign-service
/
campaigns
/
sponsored-brand
/
{campaign-id}
/
bids
Replace sponsored brand campaign bids.
curl --request PUT \
  --url https://api.topsort.com/public/v1/campaign-service/campaigns/sponsored-brand/{campaign-id}/bids \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bids": [
    {
      "target": {
        "id": "<string>"
      },
      "triggers": [
        {
          "type": "<string>",
          "value": {
            "fromProduct": "<string>"
          }
        }
      ],
      "formatProperties": {
        "imageAssets": [
          {
            "height": 123,
            "width": 123,
            "contentType": "<string>",
            "contentLength": 123,
            "url": "<string>"
          }
        ]
      },
      "amount": "<unknown>",
      "location": "Santiago"
    }
  ],
  "slotId": "<string>",
  "content": {},
  "slotIds": [
    "<string>"
  ]
}
'
import requests

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

payload = {
    "bids": [
        {
            "target": { "id": "<string>" },
            "triggers": [
                {
                    "type": "<string>",
                    "value": { "fromProduct": "<string>" }
                }
            ],
            "formatProperties": { "imageAssets": [
                    {
                        "height": 123,
                        "width": 123,
                        "contentType": "<string>",
                        "contentLength": 123,
                        "url": "<string>"
                    }
                ] },
            "amount": "<unknown>",
            "location": "Santiago"
        }
    ],
    "slotId": "<string>",
    "content": {},
    "slotIds": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    bids: [
      {
        target: {id: '<string>'},
        triggers: [{type: '<string>', value: {fromProduct: '<string>'}}],
        formatProperties: {
          imageAssets: [
            {
              height: 123,
              width: 123,
              contentType: '<string>',
              contentLength: 123,
              url: '<string>'
            }
          ]
        },
        amount: '<unknown>',
        location: 'Santiago'
      }
    ],
    slotId: '<string>',
    content: {},
    slotIds: ['<string>']
  })
};

fetch('https://api.topsort.com/public/v1/campaign-service/campaigns/sponsored-brand/{campaign-id}/bids', 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/sponsored-brand/{campaign-id}/bids",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'bids' => [
        [
                'target' => [
                                'id' => '<string>'
                ],
                'triggers' => [
                                [
                                                                'type' => '<string>',
                                                                'value' => [
                                                                                                                                'fromProduct' => '<string>'
                                                                ]
                                ]
                ],
                'formatProperties' => [
                                'imageAssets' => [
                                                                [
                                                                                                                                'height' => 123,
                                                                                                                                'width' => 123,
                                                                                                                                'contentType' => '<string>',
                                                                                                                                'contentLength' => 123,
                                                                                                                                'url' => '<string>'
                                                                ]
                                ]
                ],
                'amount' => '<unknown>',
                'location' => 'Santiago'
        ]
    ],
    'slotId' => '<string>',
    'content' => [
        
    ],
    'slotIds' => [
        '<string>'
    ]
  ]),
  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/sponsored-brand/{campaign-id}/bids"

	payload := strings.NewReader("{\n  \"bids\": [\n    {\n      \"target\": {\n        \"id\": \"<string>\"\n      },\n      \"triggers\": [\n        {\n          \"type\": \"<string>\",\n          \"value\": {\n            \"fromProduct\": \"<string>\"\n          }\n        }\n      ],\n      \"formatProperties\": {\n        \"imageAssets\": [\n          {\n            \"height\": 123,\n            \"width\": 123,\n            \"contentType\": \"<string>\",\n            \"contentLength\": 123,\n            \"url\": \"<string>\"\n          }\n        ]\n      },\n      \"amount\": \"<unknown>\",\n      \"location\": \"Santiago\"\n    }\n  ],\n  \"slotId\": \"<string>\",\n  \"content\": {},\n  \"slotIds\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.topsort.com/public/v1/campaign-service/campaigns/sponsored-brand/{campaign-id}/bids")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bids\": [\n    {\n      \"target\": {\n        \"id\": \"<string>\"\n      },\n      \"triggers\": [\n        {\n          \"type\": \"<string>\",\n          \"value\": {\n            \"fromProduct\": \"<string>\"\n          }\n        }\n      ],\n      \"formatProperties\": {\n        \"imageAssets\": [\n          {\n            \"height\": 123,\n            \"width\": 123,\n            \"contentType\": \"<string>\",\n            \"contentLength\": 123,\n            \"url\": \"<string>\"\n          }\n        ]\n      },\n      \"amount\": \"<unknown>\",\n      \"location\": \"Santiago\"\n    }\n  ],\n  \"slotId\": \"<string>\",\n  \"content\": {},\n  \"slotIds\": [\n    \"<string>\"\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"bids\": [\n    {\n      \"target\": {\n        \"id\": \"<string>\"\n      },\n      \"triggers\": [\n        {\n          \"type\": \"<string>\",\n          \"value\": {\n            \"fromProduct\": \"<string>\"\n          }\n        }\n      ],\n      \"formatProperties\": {\n        \"imageAssets\": [\n          {\n            \"height\": 123,\n            \"width\": 123,\n            \"contentType\": \"<string>\",\n            \"contentLength\": 123,\n            \"url\": \"<string>\"\n          }\n        ]\n      },\n      \"amount\": \"<unknown>\",\n      \"location\": \"Santiago\"\n    }\n  ],\n  \"slotId\": \"<string>\",\n  \"content\": {},\n  \"slotIds\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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.

Query Parameters

​
vendor_id
string
required

The ID of the vendor.

Minimum string length: 1

Body

application/json

Request body for replacing public sponsored brand bids.

​
bids
PublicCreateSponsoredBrandBid · object[]
required

An array of bids for this campaign.

Required array length: 1 - 500 elements
​
slotId
string
required

The external slot ID where the sponsored brand campaign will be shown.

Minimum string length: 1
​
content
Content · object
required

Dynamic content validated against the slot's JSON template.

​
slotIds
string[] | null

Additional external slot IDs. If present, each ID replicates the whole bid set.

Maximum array length: 10

Response

Successful Response