Create Offsite Audiences Job - Topsort Documentation

curl --request POST \ --url https://api.topsort.com/public/v1/offsite-ads/audiences/user-list \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "<string>", "dsp": [], "description": "This is a user list audience description." } '

Autorizações

Authorization

string

header

obrigatório

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.

Parâmetros de consulta

vendor_id

string | null

Limits the audience to a specific vendor when set; otherwise, the audience is available to all vendors.

Exemplo:

"vendor_123"

Corpo

application/json

name

string

obrigatório

The name of the user list audience.

Minimum string length: 1

Exemplo:

"My user list audience"

dsp

enum<string>[]

obrigatório

The DSPs to sync the audience to. Include one or more of: google_ads, meta, tiktok_ads, snapchat_ads.

Minimum array length: 1

DSPs an offsite audience is synced to.

Opções disponíveis:

google_ads,

meta,

tiktok_ads,

snapchat_ads

Exemplos:

["google_ads"]

["google_ads", "meta"]

description

string | null

The description of the user list audience.

Minimum string length: 1

Exemplo:

"This is a user list audience description."

Resposta

Successful Response

jobId

string<uuid>

obrigatório

The unique identifier for the queued job.

Exemplo:

"123e4567-e89b-12d3-a456-426614174000"

url

string

obrigatório

The presigned url to upload the audience csv file. Presigned url must be used with PUT method and include the header Content-Type: text/csv.

Exemplo:

"https://offsite-ads-user-list-uploads.s3.us-east-2.amazonaws.com/123e4567-e89b-12d3-a456-426614174000.csv"