afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/CommSubscriptionConsent.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "associated_objects",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "CommSubscriptionConsent - Data API",
  "description": "Represents a customer’s consent to a communication subscription. This object is available in API version 48.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "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": "Date when the customer’s consent was captured.",
      "required": true
    },
    "ConsentCapturedSource": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Source through which consent was captured. For example, user@example.com or www.example.com.",
      "required": true
    },
    "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: 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": "Date when consent starts.",
      "required": true
    },
    "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": "Name of the communication subscription consent record.",
      "required": true
    },
    "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.\n\n- **CommSubscriptionConsentChangeEvent (API version 49.0)**: Change events are available for the object.\n- **CommSubscriptionConsentFeed**: Feed tracking is available for the object.\n- **CommSubscriptionConsentHistory**: History is available for tracked fields of the object.\n- **CommSubscriptionConsentOwnerSharingRule**: Sharing rules are available for the object.\n- **CommSubscriptionConsentShare**: Sharing is available for the object.",
  "wsdl_segment": "```xml\n<complexType name=\"CommSubscriptionConsent\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"ActivityHistories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ApprovalSubmissions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ApprovalWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"AttachedContentDocuments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Attachments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"BusinessBrand\" nillable=\"true\" minOccurs=\"0\" type=\"ens:BusinessBrand\"/>\n        <element name=\"BusinessBrandId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CombinedAttachments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"CommSubscriptionChannelType\" nillable=\"true\" minOccurs=\"0\" type=\"ens:CommSubscriptionChannelType\"/>\n        <element name=\"CommSubscriptionChannelTypeId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CommSubscriptionTimings\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ConsentCapturedDateTime\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"ConsentCapturedSource\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ConsentGiver\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n        <element name=\"ConsentGiverId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"ContactPoint\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n        <element name=\"ContactPointId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"ContactPointValue\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ContentDocumentLinks\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"DataUsePurpose\" nillable=\"true\" minOccurs=\"0\" type=\"ens:DataUsePurpose\"/>\n        <element name=\"DataUsePurposeId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"EffectiveFromDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:date\"/>\n        <element name=\"Emails\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"EngagementChannelType\" nillable=\"true\" minOccurs=\"0\" type=\"ens:EngagementChannelType\"/>\n        <element name=\"EngagementChannelTypeId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"Events\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"FeedSubscriptionsForEntity\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Feeds\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"FlowOrchestrationWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Histories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LastReferencedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LastViewedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LookedUpFromActivities\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Notes\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"NotesAndAttachments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"OpenActivities\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Owner\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n        <element name=\"OwnerId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"Party\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Individual\"/>\n        <element name=\"PartyId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"PartyRole\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n        <element name=\"PartyRoleId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"PrivacyConsentStatus\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ProcessInstances\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ProcessSteps\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Shares\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"Tasks\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n<simpleType name=\"ID\">\n  <restriction base=\"xsd:string\">\n    <length value=\"18\"/>\n    <pattern value=\"[a-zA-Z0-9]{18}\"/>\n  </restriction>\n</simpleType>\n<simpleType name=\"QueryLocator\">\n  <restriction base=\"xsd:string\"/>\n</simpleType>\n<complexType name=\"QueryResult\">\n  <sequence>\n    <element name=\"done\" type=\"xsd:boolean\"/>\n    <element name=\"queryLocator\" type=\"tns:QueryLocator\" nillable=\"true\"/>\n    <element name=\"records\" type=\"ens:sObject\" nillable=\"true\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n    <element name=\"size\" type=\"xsd:int\"/>\n  </sequence>\n</complexType>\n```",
  "field_reference": {
    "BusinessBrandId": {
      "field_label": "Business Brand ID",
      "type": "reference",
      "length": "18"
    },
    "CommSubscriptionChannelTypeId": {
      "field_label": "Communication Subscription Channel Type ID",
      "type": "reference",
      "length": "18"
    },
    "ConsentCapturedDateTime": {
      "field_label": "Consent Captured Date Time",
      "type": "datetime"
    },
    "ConsentCapturedSource": {
      "field_label": "Consent Captured Source",
      "type": "string",
      "length": "255"
    },
    "ConsentGiverId": {
      "field_label": "Consent Giver ID",
      "type": "reference",
      "length": "18"
    },
    "ContactPointId": {
      "field_label": "Contact Point ID",
      "type": "reference",
      "length": "18"
    },
    "ContactPointValue": {
      "field_label": "Communication Subscription Consent Compliance Snapshot",
      "type": "string",
      "length": "40"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "CurrencyIsoCode": {
      "field_label": "Currency ISO Code",
      "type": "picklist",
      "length": "3"
    },
    "DataUsePurposeId": {
      "field_label": "Data Use Purpose ID",
      "type": "reference",
      "length": "18"
    },
    "EffectiveFromDate": {
      "field_label": "Effective From",
      "type": "date"
    },
    "EngagementChannelTypeId": {
      "field_label": "Engagement Channel Type ID",
      "type": "reference",
      "length": "18"
    },
    "Id": {
      "field_label": "Communication Subscription Consent ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "LastReferencedDate": {
      "field_label": "Last Referenced Date",
      "type": "datetime"
    },
    "LastViewedDate": {
      "field_label": "Last Viewed Date",
      "type": "datetime"
    },
    "Name": {
      "field_label": "Name",
      "type": "string",
      "length": "255"
    },
    "OwnerId": {
      "field_label": "Owner ID",
      "type": "reference",
      "length": "18"
    },
    "PartyId": {
      "field_label": "Individual ID",
      "type": "reference",
      "length": "18"
    },
    "PartyRoleId": {
      "field_label": "Party Role ID",
      "type": "reference",
      "length": "18"
    },
    "PrivacyConsentStatus": {
      "field_label": "Privacy Consent Status",
      "type": "picklist",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length"
  ]
}