Audiences

Global Opt Out

PUT accounts/:account_id/tailored_audiences/global_opt_out

Advertisers must maintain a list of people who have opted out of inclusion on their lists. This endpoint behaves like a special tailored audience that excludes these users from any targeting based on other audiences. For processing simplicity, you can only REPLACE your current global opt out list.

Resource URL

https://ads-api.twitter.com/3/accounts/:account_id/tailored_audiences/global_opt_out

Parameters

Name Description
account_id
required

The identifier for the leveraged account. Appears within the resource’s path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user.

Type: string

Example: 18ce54d4x5t
input_file_path
required

The file path returned by the TON API endpoint.

Type: string

Example: /1.1/ton/data/ta_partner/1877861928/Axbsh2.csv
list_type
required

The type of list for this audience.

Type: enum

Possible values: DEVICE_ID, EMAIL, HANDLE, PHONE_NUMBER, TWITTER_ID, TWITTER_COOKIE_ID

Example Request

PUT https://ads-api.twitter.com/3/accounts/18ce54d4x5t/tailored_audiences/global_opt_out?input_file_path=/1.1/ton/data/ta_partner/1877861928/Axbsh2.csv&list_type=EMAIL

Example Response

{
  "data" : {
    "input_file_path" : "/1.1/ton/data/ta_partner/1877861928/Axbsh2.csv",
    "list_type" : "EMAIL"
  },
  "request" : {
    "params" : {
      "account_id" : "18ce54d4x5t",
      "input_file_path" : "/1.1/ton/data/ta_partner/1877861928/Axbsh2.csv",
      "list_type" : "EMAIL"
    }
  }
}