Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Data Subject Groups V4

Create Data Subject Group

Use this API to create a new Data Subject Group.

🗒 Things to Know

  • Data Subject Groups must contain at least one primary data subject identifier and two data subjects.
post/rest/api/consent/v4/linkedidentitygroups

Request body

groupNamestring required

A user-defined name for the group of linked identities.

memberIdentifiersstring[] required

A list of all member identifiers that belong to the group.

primaryIdentifiersstring[] required

A List of all identifiers that are primary identifiers. The members in this list need not be present in member identifiers list as they are mutually exclusive.

Example request

{
  "groupName": "LIG_1",
  "memberIdentifiers": [
    "user_12345@ot.com",
    "user_67890@ot.com",
    "user_54321@ot.com"
  ],
  "primaryIdentifiers": [
    "user_primary@ot.com"
  ]
}

Response

OK

idstring

Unique identifier of the linked identity group

createdDatestring date-time

Date and time when the group was created

groupNamestring

Name of the group

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdDate": "2024-11-12T10:15:30",
  "groupName": "UserAccountGroup",
  "primaryDataSubjects": [
    {
      "id": "a3f8d56a-b123-4b2a-9eab-12cfea1bc456",
      "identifier": "user@example.com",
      "identifierType": "EMAIL",
      "addedDate": "2024-11-12T10:15:30"
    }
  ],
  "memberDataSubjects": [
    {
      "id": "a3f8d56a-b123-4b2a-9eab-12cfea1bc456",
      "identifier": "user@example.com",
      "identifierType": "EMAIL",
      "addedDate": "2024-11-12T10:15:30"
    }
  ]
}