Create or update campaign timetables (dayparting).

curl --request PUT \
  --url https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign_id}/timetables \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "timetables": [
    {
      "isActive": true,
      "startHour": 0,
      "endHour": 24
    }
  ]
}
'

import requests

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

payload = { "timetables": [
        {
            "isActive": True,
            "startHour": 0,
            "endHour": 24
        }
    ] }
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({timetables: [{isActive: true, startHour: 0, endHour: 24}]})
};

fetch('https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign_id}/timetables', 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}/timetables",
  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([
    'timetables' => [
        [
                'isActive' => true,
                'startHour' => 0,
                'endHour' => 24
        ]
    ]
  ]),
  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}/timetables"

	payload := strings.NewReader("{\n  \"timetables\": [\n    {\n      \"isActive\": true,\n      \"startHour\": 0,\n      \"endHour\": 24\n    }\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/{campaign_id}/timetables")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"timetables\": [\n    {\n      \"isActive\": true,\n      \"startHour\": 0,\n      \"endHour\": 24\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"timetables\": [\n    {\n      \"isActive\": true,\n      \"startHour\": 0,\n      \"endHour\": 24\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "timetables": [
    {
      "isActive": true,
      "dayOfWeek": 1,
      "updatedAt": "2023-11-07T05:31:56Z",
      "startHour": 0,
      "endHour": 24
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Campaign API

Create or update campaign timetables (dayparting).

Create or update dayparting configuration for a campaign.

Dayparting allows you to control when your campaign is active during the week. You can specify active hours for each day of the week (1=Monday, 7=Sunday).

HOUR SEMANTICS:

start_hour: Campaign starts at this hour (inclusive, 0-23)
end_hour: Campaign stops at this hour (exclusive, 1-24)
Example: start_hour=9, end_hour=17 runs from 9:00 AM to 5:00 PM
For all-day: start_hour=0, end_hour=24

This endpoint performs an upsert operation - it will create new timetables or update existing ones based on the day_of_week. Days not in the request remain unchanged.

PUT

public

campaign-service

campaigns

{campaign_id}

timetables

Create or update campaign timetables (dayparting).

curl --request PUT \
  --url https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign_id}/timetables \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "timetables": [
    {
      "isActive": true,
      "startHour": 0,
      "endHour": 24
    }
  ]
}
'

import requests

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

payload = { "timetables": [
        {
            "isActive": True,
            "startHour": 0,
            "endHour": 24
        }
    ] }
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({timetables: [{isActive: true, startHour: 0, endHour: 24}]})
};

fetch('https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign_id}/timetables', 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}/timetables",
  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([
    'timetables' => [
        [
                'isActive' => true,
                'startHour' => 0,
                'endHour' => 24
        ]
    ]
  ]),
  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}/timetables"

	payload := strings.NewReader("{\n  \"timetables\": [\n    {\n      \"isActive\": true,\n      \"startHour\": 0,\n      \"endHour\": 24\n    }\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/{campaign_id}/timetables")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"timetables\": [\n    {\n      \"isActive\": true,\n      \"startHour\": 0,\n      \"endHour\": 24\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"timetables\": [\n    {\n      \"isActive\": true,\n      \"startHour\": 0,\n      \"endHour\": 24\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "timetables": [
    {
      "isActive": true,
      "dayOfWeek": 1,
      "updatedAt": "2023-11-07T05:31:56Z",
      "startHour": 0,
      "endHour": 24
    }
  ]
}

{
  "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

timetables

PublicCampaignTimeTable · object[]

required

The schedule for the campaign.

Required array length: 1 - 7 elements

Show child attributes

Response

Successful Response

The schedule for the campaign.

campaignId

string<uuid>

required

The ID of the campaign.

timetables

PublicCampaignTimeTableResponse · object[]

required

The schedule for the campaign.

Show child attributes

General

Auction examples

Webhook examples

Auctions

Events

Toptimize

Toppie API

Campaign API

Catalog API

Billing API

Reporting API

Invitation API

User API

Webhooks API

Assets API

Segments Service

Offsite Ads API

Forecasting Service

Media API

Placement API

Export API

API Reference

Create or update campaign timetables (dayparting).

Authorizations

Path Parameters

Query Parameters

Body

Response