Saltar para o conteúdo principal
PUT
/
public
/
v1
/
offsite-ads
/
audiences
/
{audience-id}
Replace Offsite Audiences job
curl --request PUT \
  --url https://api.topsort.com/public/v1/offsite-ads/audiences/{audience-id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My user list audience",
  "description": "This is a user list audience description."
}
'
{
  "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>"
}

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 caminho

audience-id
string
obrigatório

The audience ID to replace.

Corpo

application/json
name
string | null

Optional updated name of the user list audience.

Minimum string length: 1
Exemplo:

"My user list audience"

description
string | null

Optional updated description of the user list audience.

Minimum string length: 1
Exemplo:

"This is a user list audience description."

Resposta

Accepted

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"