Create Brand Bulk Load Run
curl --request POST \
--url https://api.example.com/api/v1/admin/brand-bulk-load \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"urls": [
"<string>"
],
"market": {
"country_code": "<string>",
"country_name": "<string>",
"location_code": 123,
"language_locale": "<string>",
"language_code": "<string>"
},
"max_spend_usd": 123
}
'import requests
url = "https://api.example.com/api/v1/admin/brand-bulk-load"
payload = {
"urls": ["<string>"],
"market": {
"country_code": "<string>",
"country_name": "<string>",
"location_code": 123,
"language_locale": "<string>",
"language_code": "<string>"
},
"max_spend_usd": 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({
urls: ['<string>'],
market: {
country_code: '<string>',
country_name: '<string>',
location_code: 123,
language_locale: '<string>',
language_code: '<string>'
},
max_spend_usd: 123
})
};
fetch('https://api.example.com/api/v1/admin/brand-bulk-load', 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.example.com/api/v1/admin/brand-bulk-load",
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([
'urls' => [
'<string>'
],
'market' => [
'country_code' => '<string>',
'country_name' => '<string>',
'location_code' => 123,
'language_locale' => '<string>',
'language_code' => '<string>'
],
'max_spend_usd' => 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.example.com/api/v1/admin/brand-bulk-load"
payload := strings.NewReader("{\n \"urls\": [\n \"<string>\"\n ],\n \"market\": {\n \"country_code\": \"<string>\",\n \"country_name\": \"<string>\",\n \"location_code\": 123,\n \"language_locale\": \"<string>\",\n \"language_code\": \"<string>\"\n },\n \"max_spend_usd\": 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.example.com/api/v1/admin/brand-bulk-load")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"urls\": [\n \"<string>\"\n ],\n \"market\": {\n \"country_code\": \"<string>\",\n \"country_name\": \"<string>\",\n \"location_code\": 123,\n \"language_locale\": \"<string>\",\n \"language_code\": \"<string>\"\n },\n \"max_spend_usd\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/admin/brand-bulk-load")
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 \"urls\": [\n \"<string>\"\n ],\n \"market\": {\n \"country_code\": \"<string>\",\n \"country_name\": \"<string>\",\n \"location_code\": 123,\n \"language_locale\": \"<string>\",\n \"language_code\": \"<string>\"\n },\n \"max_spend_usd\": 123\n}"
response = http.request(request)
puts response.read_body{
"run_id": "<string>",
"status": "<string>",
"accepted_urls": 123,
"duplicates_dropped": 123,
"invalid_urls": [
"<string>"
],
"max_spend_usd": 123,
"estimated_cost_per_brand_usd": 123,
"estimated_total_cost_usd": 123,
"spend_basis": "<string>",
"spend_note": "<string>",
"eta": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Admin Brand Bulk Load
Create Brand Bulk Load Run
Accept a URL list, persist the whole run durably, return a run id.
Nothing expensive happens on this request: two INSERTs and one queue push. The run is durable before the 202 is written, which is exactly what the operator’s old submit/429/backoff loop never had — a Railway deploy one minute later resumes it instead of losing it.
POST
/
api
/
v1
/
admin
/
brand-bulk-load
Create Brand Bulk Load Run
curl --request POST \
--url https://api.example.com/api/v1/admin/brand-bulk-load \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"urls": [
"<string>"
],
"market": {
"country_code": "<string>",
"country_name": "<string>",
"location_code": 123,
"language_locale": "<string>",
"language_code": "<string>"
},
"max_spend_usd": 123
}
'import requests
url = "https://api.example.com/api/v1/admin/brand-bulk-load"
payload = {
"urls": ["<string>"],
"market": {
"country_code": "<string>",
"country_name": "<string>",
"location_code": 123,
"language_locale": "<string>",
"language_code": "<string>"
},
"max_spend_usd": 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({
urls: ['<string>'],
market: {
country_code: '<string>',
country_name: '<string>',
location_code: 123,
language_locale: '<string>',
language_code: '<string>'
},
max_spend_usd: 123
})
};
fetch('https://api.example.com/api/v1/admin/brand-bulk-load', 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.example.com/api/v1/admin/brand-bulk-load",
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([
'urls' => [
'<string>'
],
'market' => [
'country_code' => '<string>',
'country_name' => '<string>',
'location_code' => 123,
'language_locale' => '<string>',
'language_code' => '<string>'
],
'max_spend_usd' => 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.example.com/api/v1/admin/brand-bulk-load"
payload := strings.NewReader("{\n \"urls\": [\n \"<string>\"\n ],\n \"market\": {\n \"country_code\": \"<string>\",\n \"country_name\": \"<string>\",\n \"location_code\": 123,\n \"language_locale\": \"<string>\",\n \"language_code\": \"<string>\"\n },\n \"max_spend_usd\": 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.example.com/api/v1/admin/brand-bulk-load")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"urls\": [\n \"<string>\"\n ],\n \"market\": {\n \"country_code\": \"<string>\",\n \"country_name\": \"<string>\",\n \"location_code\": 123,\n \"language_locale\": \"<string>\",\n \"language_code\": \"<string>\"\n },\n \"max_spend_usd\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/admin/brand-bulk-load")
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 \"urls\": [\n \"<string>\"\n ],\n \"market\": {\n \"country_code\": \"<string>\",\n \"country_name\": \"<string>\",\n \"location_code\": 123,\n \"language_locale\": \"<string>\",\n \"language_code\": \"<string>\"\n },\n \"max_spend_usd\": 123\n}"
response = http.request(request)
puts response.read_body{
"run_id": "<string>",
"status": "<string>",
"accepted_urls": 123,
"duplicates_dropped": 123,
"invalid_urls": [
"<string>"
],
"max_spend_usd": 123,
"estimated_cost_per_brand_usd": 123,
"estimated_total_cost_usd": 123,
"spend_basis": "<string>",
"spend_note": "<string>",
"eta": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Response
Successful Response
Was this page helpful?
⌘I