Fields

The request object must contain the following fields:

FieldTypeDescription
operationString

Possible values:
ADD
REMOVE
Indicates if the submitted users should be added or removed.
audience_idNumberThe ID of the First Party Audience, passed as a Number - e.g. 19.
identitiesA collection of User objects. (See below)See examples and object schema below.
integration_sourceString(Optional)

This field is for 3rd-party platforms only. Advertisers managing their own audiences can ignore this field.
--

Used for integration tracking and diagnostics.

Pass the same value that you passed for audience creation.
{
  "operation": "REMOVE",
  "audience_id": 19,
  "integration_source": "Tealium",
  "identities": [
    {
      // User 1
    },
    {
      // User 2
    }
  ]
}
{
  "operation": "REMOVE",
  "audience_id": 19,
  "integration_source": "Tealium",
  "identities": [
    {
      "cluster": [
        // User IDs for User 1
      ]
    },
    {
      "cluster": [
        // User IDs for User 2
      ]
    }
  ]
}
{
  "operation": "ADD",
  "audience_id": 19,
  "integration_source": "Tealium",
  "identities": [
    {
      "cluster": [
        {
          // User ID 'A' (for User 1)
        }
      ]
    },
    {
      "cluster": [
        {
          // User ID 'B' (for User 2)
        },
        {
          // User ID 'C' (for User 2)
        }
      ]
    }
  ]
}

📘

For information about each object, see below.