PartyConsent

Represents consent preferences for an individual.

Introduced in API version 48.0.

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

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
  • Description: The action that the Individual is consenting to.
  • Possible values:
    • CrossDevice — CrossDevice
    • DataCollection — DataCollection
    • Reidentification — Reidentification
    • Segment — Segment
    • ShareData — ShareData
    • Target — Target

  • Type: reference

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

  • Introduced: API version 53.0

  • Relationship name: BusinessBrand

  • Relationship type: relationship

  • Refers to: BusinessBrand

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Required. Indicates how you captured consent.
  • Possible values:
    • Email — Email
    • MailingAddress — MailingAddress
    • Phone — Phone
    • Social — Social
    • Web — Web
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Required. Date when consent was captured.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Required. Indicates how you captured consent. For example, a website or online form.

  • Type: reference

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

  • Introduced: API version 57.0

  • Relationship name: DataUsePurpose

  • Relationship type: relationship

  • Refers to: DataUsePurpose

  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The specific date and time the consent was confirmed for the data subject via a secondary verification method (for example, clicking a link in a confirmation email). Essential for high-standard Double Opt-In audit trails.
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The date the data subject’s consent becomes valid. Use this field to track the beginning of the legal period for which the party has agreed to data processing or communication.
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The date the data subject’s consent expires or is scheduled to end. This field helps automate compliance by identifying when consent should no longer be honored.
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: Name of the party consent record.

  • Type: reference

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

  • Description:

    Required. Represents the record based on the Individual object 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

  • Relationship name: PartyRole

  • Relationship type: polymorphic

  • Refers to: Customer, Seller

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
  • Description: Required. Identifies whether the individual associated with this record agrees to this form of contact.
  • 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.