--- schema_version: "1" id: 97ac55fdb23b4a092be2f61a6c9a7f253bc532b0c52b361930092040fba90c35 title: CommSubscriptionConsent collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_commsubscriptionconsent.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_commsubscriptionconsent.htm source_site: developer.salesforce.com content_type: documentation content_hash: 2d2d15b228d7e561e66ba9baf71665134c30db243c9b99421e613f4330b5d181 description: Represents a customer’s consent to a communication subscription. This object is available in API version 48.0 and later. --- # CommSubscriptionConsent Represents a customer’s consent to a communication subscription. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields With certain page layout and field-level security settings, some fields aren't visible or editable. | Field | Details | | --- | --- | | BusinessBrandId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the Business Brand that the individual has given consent to for a communication subscription. This is a relationship field. This field is available in API version 53.0 and later. Relationship Name BusinessBrand Relationship Type Lookup Refers To BusinessBrand | | CommSubscriptionChannelTypeId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the associated communication subscription channel type record. This is a relationship field. Relationship Name CommSubscriptionChannelType Relationship Type Lookup Refers To CommSubscriptionChannelType | | ConsentCapturedDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Required. Date when the customer’s consent was captured. | | ConsentCapturedSource | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Required. Source through which consent was captured. For example, user@example.com or www.example.com. | | ConsentGiverId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the person who gave consent to the communication subscription on behalf of the contact point. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If the contact point gave consent, don't use ConsentGiverId. This is a polymorphic relationship field. Relationship Name ConsentGiver Relationship Type Lookup Refers To Account, Contact, Individual, User | | ContactPointId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the contact point, such as an Individual or person account, associated with the communication subscription consent. This is a polymorphic relationship field. Relationship Name ContactPoint Relationship Type Lookup Refers To ContactPointAddress, ContactPointEmail, ContactPointPhone | | ContactPointValue | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The value of the contact point. | | DataUsePurposeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Represents the record for data use purpose that you want to associate this consent with. This field is available in API version 57.0 and later. This is a relationship field. Relationship Name DataUsePurpose Relationship Type Lookup Refers To DataUsePurpose | | EffectiveFromDate | Type date Properties Create, Filter, Group, Sort, Update Description Required. Date when consent starts. | | EffectiveToDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Date when consent ends. This field is restricted by field-level security. | | EngagementChannelTypeId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Represents the contact method you want to apply consent to. This field is available in API version 57.0 and later. This is a relationship field. Relationship Name EngagementChannelType Relationship Type Lookup Refers To EngagementChannelType | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. Name of the communication subscription consent record. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the account owner associated with this customer. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PartyId | Type reference Properties Filter, Group, Nillable, Sort Description Represents the record based on the Individual object that you want to associate consent with. This field is available in API version 57.0 and later. This is a relationship field. Relationship Name Party Relationship Type Lookup Refers To Individual | | PartyRoleId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the Party Role for the individual you want to associate consent with. This is a polymorphic relationship field. This field is available in API version 53.0 and later. Relationship Name PartyRole Relationship Type Lookup Refers To Customer, Seller | | PrivacyConsentStatus | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Identifies whether the individual or person account associated with this record agrees to this form of contact. Possible values are: - NotSeen - OptIn - OptInPending—Available in API version 58.0 and later. - OptOut - OptOutPending—Available in API version 58.0 and later. - Seen The default value is NotSeen. This field is available in API version 57.0 and later. | ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. [CommSubscriptionConsentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 49.0) Change events are available for the object. [CommSubscriptionConsentFeed](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CommSubscriptionConsentHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [CommSubscriptionConsentOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [CommSubscriptionConsentShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object.