CommSubscriptionConsent

Represents a customer’s consent to a communication subscription.

Introduced in API version 48.0.

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 53.0
  • Description: The ID of the Business Brand that the individual has given consent to for a communication subscription. This is a relationship field.
  • Relationship name: BusinessBrand
  • Relationship type: relationship
  • Refers to: BusinessBrand

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 60.0

  • Relationship name: BusinessContext

  • Relationship type: relationship

  • Refers to: FinancialAccount

  • 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: relationship

  • Refers to: CommSubscriptionChannelType

  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Required. Date when the customer’s consent was captured.
  • 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.

  • 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.

    This is a polymorphic relationship field.

  • Relationship name: ConsentGiver

  • Relationship type: polymorphic

  • Refers to: Account, Contact, Individual, User

    If the contact point gave consent, don’t use ConsentGiverId.

  • 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: polymorphic

  • Refers to: ContactPointAddress, ContactPointEmail, ContactPointOttSvc, ContactPointPhone, ContactPointSocial

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 61.0
  • Description: The value of the contact point.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 57.0

  • Description:

    Represents the record for data use purpose that you want to associate this consent with.

    This is a relationship field.

  • Relationship name: DataUsePurpose

  • Relationship type: relationship

  • Refers to: DataUsePurpose

  • Type: date
  • Properties: Create, Filter, Group, Sort, Update
  • Description: Required. Date when consent starts.
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Date when consent ends. This field is restricted by field-level security.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 57.0

  • Description:

    Represents the contact method you want to apply consent to.

    This is a relationship field.

  • Relationship name: EngagementChannelType

  • Relationship type: relationship

  • Refers to: EngagementChannelType

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: Required. Name of the communication subscription consent record.

  • Type: reference

  • Properties: Filter, Group, Nillable, Sort

  • Introduced: API version 57.0

  • Description:

    Represents the record based on the Individual object that you want to associate consent with.

    This is a relationship field.

  • Relationship name: Party

  • Relationship type: relationship

  • Refers to: Individual

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 53.0
  • Description: The ID of the Party Role for the individual you want to associate consent with. This is a polymorphic relationship field.
  • Relationship name: PartyRole
  • Relationship type: polymorphic
  • Refers to: Customer, Seller

  • Type: picklist

  • Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update

  • Introduced: API version 57.0

  • Description:

    Identifies whether the individual or person account associated with this record agrees to this form of contact.

    The default value is NotSeen.

  • Possible values:

    • NotSeen — NotSeen
    • OptIn — OptIn
    • OptInPending — OptInPending — Available in API version 58.0 and later.
    • OptOut — OptOut
    • OptOutPending — OptOutPending — Available in API version 58.0 and later.
    • Seen — Seen

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.