Fields

The request object must contain the following fields:

Field

Type

Description

operation

String

Possible values:
ADD
REMOVE

Indicates if the submitted users should be added or removed.

audience_id

Number

The ID of the First Party Audience, passed as a Number - e.g. 19.

identities

A collection of User objects. (See below)

See examples and object schema below.

{
   "operation": "REMOVE",
   "audience_id": 19,
   "identities": [
      {
         // User 1
      },
      {
         // User 2
      }
   ]
}
{
   "operation": "REMOVE",
   "audience_id": 19,
   "identities": [
      {
         "cluster": [
            // User IDs for User 1
         ]
      },
      {
         "cluster": [
            // User IDs for User 2
         ]
      }
   ]
}
{
   "operation": "ADD",
   "audience_id": 19,
   "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.