User Object

Each User object contains a single cluster property that groups all the User IDs for 1 user:

Field Name

Type

Description

cluster

Holds a collection of User ID objects.

See object schema below.

The cluster property groups all the User IDs for 1 user.

If you need to pass multiple email addresses and multiple Device IDs for the same user, group all of them in the same cluster.

See examples below.

{
   "cluster": [
      {
         "user_id": "836f82db99121b3481011f16b49dfa5fbc714a0d1b1b9f784a1ebbbf5b39577f",
         "type": "EMAIL_ID",
         "is_hashed": true
      }
   ]
}
{
   "cluster": [
      {
         "user_id": "86e0b9e56c17cc4d12387e1949b85053fbe73bc3ce5a1188713a9d300cc6133d",
         "type": "EMAIL_ID",
         "is_hashed": true
      },
      {
         "user_id": "00000000-89ABCDEF-01234567-89ABCDEF",
         "type": "DEVICE_ID",
         "is_hashed": false
      }
   ]
}
{
   "cluster": [
      {
         "user_id": "072ae592cac43a9108cfe86c9b744df3d0798427928bd9cfc962c8aa3402e176",
         "type": "EMAIL_ID",
         "is_hashed": true
      },
      {
         "user_id": "ce933dfc21a71c43136deeaf23d1e148328ba0a1f21b8938ae6a780760a64905",
         "type": "EMAIL_ID",
         "is_hashed": true
      },
      {
         "user_id": "01234567-89ABCDEF-01234567-89ABCDEF",
         "type": "DEVICE_ID",
         "is_hashed": false
      }
   ]
}

🚧

Guidelines

  1. If you need to pass multiple email addresses and multiple Device IDs for the same user, group all of them in the same cluster.
  2. Do not group email addresses or Device IDs for 2 different users in the same cluster.