---
title: "Update Data Subject Group"
method: PUT
path: "/api/consentmanager/v2/linkedidentitygroups/{linkedIdentityGroupId}"
tags: ["Data Subject Groups"]
---

# Update Data Subject Group

`PUT /api/consentmanager/v2/linkedidentitygroups/{linkedIdentityGroupId}`

## Request

- Base URL: `https://hostname`
- URL: `https://hostname/api/consentmanager/v2/linkedidentitygroups/{linkedIdentityGroupId}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `CONSENT`

Use this API to update an existing Data Subject Group.

> 🗒 Things to Know
> 
> - Data Subject Groups must contain at least one primary data subject identifier and two data subjects.
> - To update the Data Subject Group name, use the `groupName` parameter and enter a new name different from the one already in use.

## Path parameters

- `linkedIdentityGroupId` string, uuid, required

## Request body

- ConsentPreferencesUniversalConsentPreferenceManagLinkedIdentityGroupRequestDetailed
  - `identifiers` string[]: A list of all the Data Subject identifiers to be added to the group; must be at least 2
  - `primaryIdentifier` string[]: List of all primary Data Subject identifiers of the group; must be contained in the identifiers list
  - `groupName` string: Name of the Linked Identity Group

## Response `200`

OK - Successfully updated Data Subject Group.

- ConsentPreferencesUniversalConsentPreferenceManagLinkedIdentityGroupDtoDetailed
  - `id` string, uuid: Globally unique identifier of a Linked Identity Group
  - `createdDate` string, date-time: Creation date of a Linked Identity Group
  - `primaryDataSubject` ConsentPreferencesUniversalConsentPreferenceManagDataSubjectEntryDetailed
    - `id` string, uuid: Unique identifier of the Data Subject
    - `identifier` string, required: The identifier value of the Data Subject
    - `identifierType` string, required: The type of identifier used for the Data Subject (e.g., Email, Phone, CustomID)
    - `isPrimary` boolean: Boolean flag that denotes if the Data Subject is the primary of the group
    - `canBePrimary` boolean: Boolean flag that denotes if the Data Subject is allowed to be the group primary
    - `addedDate` string, date-time: The date that the Data Subject was added to the group
    - `numberOfLinkedGroups` integer: The number of Other Linked Groups the Data Subject is a member of
    - `magicLinkToken` string: Authentication token used for magic link functionality
    - `magicLinkTokenEncoded` string: URL-encoded version of the magic link token for direct use in URLs
    - `organizations` string[]: Set of organization UUIDs associated with this Data Subject
  - `primaryDataSubjects` ConsentPreferencesUniversalConsentPreferenceManagDataSubjectEntryDetailed[]: List of primary Data Subjects in the Linked Identity Group
    - `id` string, uuid: Unique identifier of the Data Subject
    - `identifier` string, required: The identifier value of the Data Subject
    - `identifierType` string, required: The type of identifier used for the Data Subject (e.g., Email, Phone, CustomID)
    - `isPrimary` boolean: Boolean flag that denotes if the Data Subject is the primary of the group
    - `canBePrimary` boolean: Boolean flag that denotes if the Data Subject is allowed to be the group primary
    - `addedDate` string, date-time: The date that the Data Subject was added to the group
    - `numberOfLinkedGroups` integer: The number of Other Linked Groups the Data Subject is a member of
    - `magicLinkToken` string: Authentication token used for magic link functionality
    - `magicLinkTokenEncoded` string: URL-encoded version of the magic link token for direct use in URLs
    - `organizations` string[]: Set of organization UUIDs associated with this Data Subject
  - `dataSubjects` ConsentPreferencesUniversalConsentPreferenceManagDataSubjectEntryDetailed[]: A list of all the linked Data Subjects in the group
    - `id` string, uuid: Unique identifier of the Data Subject
    - `identifier` string, required: The identifier value of the Data Subject
    - `identifierType` string, required: The type of identifier used for the Data Subject (e.g., Email, Phone, CustomID)
    - `isPrimary` boolean: Boolean flag that denotes if the Data Subject is the primary of the group
    - `canBePrimary` boolean: Boolean flag that denotes if the Data Subject is allowed to be the group primary
    - `addedDate` string, date-time: The date that the Data Subject was added to the group
    - `numberOfLinkedGroups` integer: The number of Other Linked Groups the Data Subject is a member of
    - `magicLinkToken` string: Authentication token used for magic link functionality
    - `magicLinkTokenEncoded` string: URL-encoded version of the magic link token for direct use in URLs
    - `organizations` string[]: Set of organization UUIDs associated with this Data Subject
  - `groupName` string: The name of the linked identity group

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).
- `500`: Internal Server Error

---

[API](https://skmtc.dev/onetrust/apis/consent-preferences-universal-consent-preference-management.md) - [All operations](https://skmtc.dev/onetrust/apis/consent-preferences-universal-consent-preference-management/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/consent-preferences-universal-consent-preference-management/revisions/fe4a0697ec9d?raw)