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

137 lines
4.1 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"field_reference"
],
"title": "SurveyEmailBranding - Data API",
"description": "Represents the configuration settings for invitation emails sent to survey participants for a particular survey.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"Body": {
"type": "textarea",
"properties": "Create, Update",
"description": "The body text of the invitation email."
},
"DeveloperName": {
"type": "string",
"properties": "Create, Filter, Group, Sort, Update",
"description": "The unique API name of the email branding configuration. Note: Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field."
},
"FooterImageId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The ID of the content asset that appears in the footer of the invitation email."
},
"FromEmailAddress": {
"type": "email",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The email address that appears in the “From” field when the invitation is sent to participants."
},
"HeaderImageId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The ID of the content asset that appears in the header of the invitation email."
},
"Language": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "The language of the emails. Available languages include: Chinese (Simplified) Chinese (Traditional) Danish Dutch English Finnish French German Italian Japanese Korean Norwegian Portuguese (Brazilian) Russian Spanish Spanish (Mexican) Swedish Thai"
},
"MasterLabel": {
"type": "string",
"properties": "Create, Filter, Group, Sort, Update",
"description": "The label for these email configuration settings."
},
"Subject": {
"type": "string",
"properties": "Create, Filter, Group, Sort, Update",
"description": "The subject of the invitation email."
}
},
"special_access_rules": "As of Spring 20 and later, only users with the View Setup and Configuration permission can access this object.",
"field_reference": {
"Body": {
"field_label": "Email Body",
"type": "textarea",
"length": "4000"
},
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"DeveloperName": {
"field_label": "Name",
"type": "string",
"length": "80"
},
"FooterImageId": {
"field_label": "Asset File ID",
"type": "reference",
"length": "18"
},
"FromEmailAddress": {
"field_label": "Email From Address",
"type": "email",
"length": "80"
},
"HeaderImageId": {
"field_label": "Asset File ID",
"type": "reference",
"length": "18"
},
"Id": {
"field_label": "Survey Email Branding ID",
"type": "id",
"length": "18"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"Language": {
"field_label": "Master Language",
"type": "picklist",
"length": "40"
},
"LastModifiedById": {
"field_label": "Last Modified By ID",
"type": "reference",
"length": "18"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"MasterLabel": {
"field_label": "Label",
"type": "string",
"length": "80"
},
"Subject": {
"field_label": "Email Subject",
"type": "string",
"length": "255"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}