Use this API to create a new data subject or update an existing data subject. The data subject will be created or updated with the details provided in the request body.

🗒

Things to Know

• The data subject primary identifier cannot be updated. However, additional identifiers can be added, updated, or deleted:
  • To add or update an additional identifier for a given data subject, set the linked parameter value to true and include a list of the additional identifiers within the value parameter.
  • To remove an additional identifier from a given data subject, set the linked parameter value to true and leave the value parameter empty. Removed identifiers will remain associated with the data subject as data elements.
• This API is not designed to be used in synchronous workflows and will not trigger integration events or reporting updates.

Below are templated examples of adding, editing, and deleting additional identifiers for the data subject.

{
  "dataElements": [
    {
      "name": "ADDITIONAL_IDENTIFIER_TYPE", // For example: Email
      "linked": true, // When dealing with identifiers, set this value to true
      "value": ["EXISTING IDENTIFIER", "NEW_IDENTIFIER"] // Make sure to keep the existing identifier if you already have one for that type
    }
  ]
}

{
  "dataElements": [
    {
      "name": "ADDITIONAL_IDENTIFIER_TYPE", // For example: Email
      "linked": true, // When dealing with identifiers, set this value to true
      "value": ["EDITED IDENTIFIER"] // Make sure to keep the existing identifier if you already have one for that type
    }
  ]
}

{
  "dataElements": [
    {
      "name": "ADDITIONAL_IDENTIFIER_TYPE", // For example: Email
      "linked": true, // When dealing with identifiers, set this value to true
      "value": [] // Keep empty if you want to remove all additional identifiers that share the identifier type
    }
  ]
}