ConsentTemplate

Represents a consent template. This object is available in API version 68.0 and later.

Supported Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Special Access Rules

Preference Center is required. Users with the Manage Preference Center user permission access consent templates.

Fields

Field Details
Description
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A description of the consent template. Maximum length is 255 characters.
DeveloperName
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The name of the consent template. Maximum length is 80 characters.
IsActive
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the consent template is active.
The default value is false.
Language
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The master language of the label. Maximum length is 40 characters.
Possible values are:
  • da—Danish
  • de—German
  • en_US—English
  • es—Spanish
  • es_MX—Spanish (Mexico)
  • fi—Finnish
  • fr—French
  • it—Italian
  • ja—Japanese
  • ko—Korean
  • nl_NL—Dutch
  • no—Norwegian
  • pt_BR—Portuguese (Brazil)
  • ru—Russian
  • sv—Swedish
  • th—Thai
  • zh_CN—Chinese (Simplified)
  • zh_TW—Chinese (Traditional)
MasterLabel
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The label for the consent template. Maximum length is 80 characters.
Type
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The type of consent template.
Possible values are:
  • basic—Basic
  • channel—Channel
  • data_cloud_subscription—Subscription
  • detailed—Detailed
  • subscription—Subscription