You are here:
Consent Attributes and Legacy Object Mapping
Review the attributes that make up a consent record and see how they map to the standard Salesforce consent objects.
Required Editions
| Available in: Enterprise, Performance, Unlimited, and Developer Editions. Requires the Privacy Center license. |
Global Consent Manager stores consent as a set of attributes on a single consent record instead of spreading it across separate objects. Some attributes store a snapshot, which is a point-in-time copy of a referenced value that's captured when the consent record is created. A snapshot keeps the consent record accurate even if the source record changes later. Attributes that reference external data come in pairs. The ID attribute identifies a source reference, and the Value attribute stores a snapshot of that value at the time the consent record is created. For example, Data Subject ID can point to the data subject's Individual record, and Data Subject Value can capture the data subject's name from that same Individual record. Map each ID and Value attribute pair to the same parent object. System-generated attributes are set automatically and aren't included in mapping.
Consent Attribute Schema
| Attribute Label | API Name | API Type | Event Stream Name | Event Stream Type | Description |
|---|---|---|---|---|---|
| Global Consent Key | GlobalConsentKey | TEXT (255) | GlobalConsentKey | TEXT | The Global Consent Key is the Primary Key that defines the unique consent record. Comprised of Global Consent Definition segment attribute values. |
| Global Consent Definition | GlobalConsentDefinition | TEXT (18) | GlobalConsentDefinition | TEXT | The Global Consent Definition ID associated with the consent record. |
| Data Subject ID | DataSubjectId | TEXT (255) | DataSubjectRecord | TEXT | Data subject associated with the consent. Mapped as part of the Consent Definition setup. One complete pair is required: either Data Subject ID and Data Subject Value, or Contact Point ID and Contact Point Value. |
| Data Subject Source ID | DataSubjectRecordId | TEXT (255) | DataSubjectSourceRecord | TEXT | Captured automatically from the associated data subject record so the originating record ID is retained if the Data Subject ID is mapped to something else. |
| Data Subject Value | DataSubjectValue | TEXT (255) | DataSubject | TEXT | Snapshot of the data subject at the time the consent record was created. One complete pair is required: either Data Subject ID and Data Subject Value, or Contact Point ID and Contact Point Value. |
| Consent Giver ID | ConsentGiverId | TEXT (50) | ConsentGiverRecordId | TEXT | The person who provided consent. Usually the same as the data subject, but can differ when consent is given on behalf of another person. |
| Consent Giver Value | ConsentGiverValue | TEXT (50) | ConsentGiver | TEXT | Snapshot of the consent giver at the time the consent record was created. |
| Residency Country | ResidencyCountry | TEXT (50) | ResidencyCountry | TEXT | Reserved for future use. |
| Residency State/Province | ResidencyState/Province | TEXT (50) | ResidencyStateProvince | TEXT | Reserved for future use. |
| Consent Method | ConsentMethod | PICKLIST (50) | ConsentMethod | TEXT | Whether consent was captured as explicit or implied. Values assigned through Residency Rules are implicit consent. |
| Consent Status | ConsentStatus | PICKLIST (255) | ConsentStatus | TEXT | Current status of consent given by a data subject. |
| Consent Type | ConsentType | PICKLIST (50) | ConsentType | TEXT | The use case consent was captured for, such as Communication or Action. |
| Consent Capture Time | ConsentCaptureTime | DATETIME (UTC) | ConsentCaptureTimestamp | DATETIME | Date and time consent was granted. |
| Consent DOI Capture | ConsentDOICapture | DATETIME (UTC) | ConsentDoiCapture | DATETIME | Date and time Double Opt In (DOI) consent was granted. |
| Consent Effective From | ConsentEffectiveFrom | DATETIME (UTC) | ConsentEffectiveFrom | DATETIME | Date and time when consent becomes valid. Can't be later than Consent Effective To. |
| Consent Effective To | ConsentEffectiveTo | DATETIME (UTC) | ConsentEffectiveTo | DATETIME | Date and time when consent is no longer valid. Can't be earlier than Consent Effective From. |
| Consent Capture Source | ConsentCaptureSource | TEXT (255) | ConsentCaptureSource | TEXT | Source through which consent was captured. |
| Consent Capture Source Type | ConsentCaptureSourceType | TEXT (255) | ConsentCaptureSourceType | TEXT | A specific source name and version, such as a preference form. |
| Consent Captured Engagement Channel ID | ConsentCapturedEngagementChannelID | TEXT (255) | ConsentCaptureSource | TEXT | The specific engagement channel through which consent was captured. |
| Consent Captured Engagement Channel Value | ConsentCapturedEngagementChannelValue | TEXT (255) | ConsentCapturedEngagementChannelValue | TEXT | Snapshot of the engagement channel through which consent was captured. |
| Brand ID | BrandID | TEXT (50) | BrandRecord | TEXT | The brand or business unit associated with consent, used for segmentation at the time the consent record was created. |
| Brand Value | BrandValue | TEXT (50) | Brand | TEXT | Snapshot of the brand or business unit associated with consent, used for segmentation. |
| Consent Purpose | ConsentPurpose | PICKLIST (255) | ConsentPurpose | TEXT | The specific reason or context for which consent is collected. |
| Data Use Purpose ID | DataUsePurposeId | TEXT (255) | DataUsePurposeRecord | TEXT | The specific Data Use Purpose associated with consent at the time the record was created. |
| Data Use Purpose Value | DataUsePurposeValue | TEXT (50) | DataUsePurpose | TEXT | Snapshot of the Data Use Purpose value at the time the record was created. |
| Engagement Channel ID | EngagementChannelId | TEXT (50) | EngagementChannelSourceRecord | TEXT | The specific engagement channel associated with consent at the time the record was created. |
| Engagement Channel Value | EngagementChannelValue | TEXT (50) | EngagementChannel | TEXT | Snapshot of the engagement channel type at the time the record was created. |
| Contact Point ID | ContactPointId | TEXT (50) | ContactPointSourceRecord | TEXT | The specific contact point associated with consent at the time the record was created. One complete pair is required: either Data Subject ID and Data Subject Value, or Contact Point ID and Contact Point Value. |
| Contact Point Value | ContactPointValue | TEXT (50) | ContactPoint | TEXT | Snapshot of the contact point associated with consent at the time the record was created. One complete pair is required: either Data Subject ID and Data Subject Value, or Contact Point ID and Contact Point Value. |
| Additional Partition ID | AdditionalPartitionId | JSON BLOB (10 MB) | AdditionalPartition | TEXT(10000) | Reserved for non-standard identifiers required to reconcile or segment records separately from a standard identity. |
| Additional Consent Parameters | AdditionalConsentParameters | JSON BLOB (10 MB) | AdditionalConsentParameters | TEXT(10000) | Attributes that affect post-processing or core reconciliation of the consent event. These parameters define the rules of the consent. |
| Additional Consent Options | AdditionalConsentOptions | JSON BLOB (10 MB) | AdditionalConsentOptions | TEXT(10000) | Supplementary metadata that adds detail on how consent is executed but doesn't affect the uniqueness or reconciliation of the record. |
Legacy Object Mapping
If you currently track consent in the standard Salesforce consent objects, use this table to find where each field maps in the Global Consent Manager attribute model. Attributes that aren't listed are new to Global Consent Manager and have no legacy equivalent.
| Global Consent Attribute | Party Consent | Contact Point Type Consent | Contact Point Consent | Communication Subscription Consent |
|---|---|---|---|---|
| Data Subject ID | PartyId | PartyId | PartyRoleId (links to Individual via PartyId) | ConsentGiverId |
| Consent Status | PrivacyConsentStatus | PrivacyConsentStatus | PrivacyConsentStatus | PrivacyConsentStatus |
| Consent Capture Time | CaptureDate | CaptureDate | CaptureDate | ConsentCapturedDateTime |
| Consent DOI Capture | DoubleConsentCaptureDate | DoubleConsentCaptureDate | DoubleConsentCaptureDate | — |
| Consent Effective From | EffectiveFrom | EffectiveFrom | EffectiveFrom | EffectiveFrom |
| Consent Effective To | EffectiveTo | EffectiveTo | EffectiveTo | EffectiveTo |
| Consent Capture Source | CaptureSource | CaptureSource | CaptureSource | ConsentCapturedSource |
| Consent Captured Engagement Channel ID | CaptureContactPointType or CaptureSource | CaptureContactPointType or CaptureSource | CaptureContactPointType or CaptureSource | — |
| Consent Captured Engagement Channel Value | CaptureContactPointType | CaptureContactPointType | CaptureContactPointType | — |
| Brand ID | BusinessBrandId | BusinessBrandId | BusinessBrandId | BusinessBrandId |
| Brand Value | Name | Name | Name | Name |
| Engagement Channel ID | — | EngagementChannelTypeId | EngagementChannelTypeId | EngagementChannelTypeId |
| Engagement Channel Value | — | Name | Name | Name |
| Contact Point ID | — | — | ContactPointId | ContactPointId |
| Contact Point Value | — | — | Varies by contact point type (for example, EmailAddress for Contact Point Email) | Varies by contact point type (for example, EmailAddress for Contact Point Email) |
