Shared mAPI reference
Complete reference documentation for the Shared resource.
Shared
#Resources that are shared across the API.
PageInfo
#The information about a paginated result.
Attributes
The cursor to fetch entries after. Will only be present if there are more entries to fetch.
The cursor to fetch entries before. Will only be present if there are more entries to fetch before the current page.
The number of entries to fetch per-page.
MessageTypeBooleanField
#A boolean field used in a message type.
Attributes
The unique key of the field.
The label of the field.
Settings for the boolean field.
The default value of the boolean field.
Whether the field is required.
The type of the field.
MessageTypeButtonField
#A button field used in a message type.
Attributes
A text field used in a message type.
The unique key of the field.
The label of the field.
Settings for the text field.
The default value of the text field.
Whether the field is required.
The type of the field.
The unique key of the field.
The label of the field.
Settings for the button field.
Whether the field is required.
A text field used in a message type.
The unique key of the field.
The label of the field.
Settings for the text field.
The default value of the text field.
Whether the field is required.
The type of the field.
The type of the field.
MessageTypeImageField
#An image field used in a message type.
Attributes
A text field used in a message type.
The unique key of the field.
The label of the field.
Settings for the text field.
The default value of the text field.
Whether the field is required.
The type of the field.
A text field used in a message type.
The unique key of the field.
The label of the field.
Settings for the text field.
The default value of the text field.
Whether the field is required.
The type of the field.
The unique key of the field.
The label of the field.
Settings for the image field.
Whether the field is required.
The type of the field.
A URL field used in a message type.
The unique key of the field.
The label of the field.
Settings for the url field.
The default value of the URL field.
Whether the field is required.
The type of the field.
MessageTypeUrlField
#A URL field used in a message type.
Attributes
The unique key of the field.
The label of the field.
Settings for the url field.
The default value of the URL field.
Whether the field is required.
The type of the field.
MessageTypeJsonField
#A JSON field used in a message type.
Attributes
The unique key of the field.
The label of the field.
Settings for the json field.
The default value of the JSON field.
Whether the field is required.
A JSON schema used to validate the structure of the JSON provided. Must be a valid JSON schema.
The type of the field.
MessageTypeMarkdownField
#A markdown field used in a message type.
Attributes
The unique key of the field.
The label of the field.
Settings for the markdown field.
The default value of the markdown field.
Whether the field is required.
The type of the field.
MessageTypeMultiSelectField
#A multi-select field used in a message type.
Attributes
The unique key of the field.
The label of the field.
Settings for the multi_select field.
The default values for the multi-select field.
The available options for the multi-select field.
The display label for the option.
The value for the option.
Whether the field is required.
The type of the field.
MessageTypeSelectField
#A select field used in a message type.
Attributes
The unique key of the field.
The label of the field.
Settings for the select field.
The default value for the select field.
The available options for the select field.
The display label for the option.
The value for the option.
Whether the field is required.
The type of the field.
MessageTypeTextField
#A text field used in a message type.
Attributes
The unique key of the field.
The label of the field.
Settings for the text field.
The default value of the text field.
Whether the field is required.
The type of the field.
MessageTypeTextareaField
#A textarea field used in a message type.
Attributes
The unique key of the field.
The label of the field.
Settings for the textarea field.
The default value of the textarea field.
Whether the field is required.
The type of the field.
MessageTypeColorField
#A hex color field (#RGB or #RRGGBB) used in a message type or partial input schema.
Attributes
The unique key of the field.
The label of the field.
Settings for the color field.
The default hex color value.
Whether the field is required.
The type of the field.
MessageTypeNumberField
#A numeric field used in a message type or partial input schema, with optional min/max bounds and a unit label for display.
Attributes
The unique key of the field.
The label of the field.
Settings for the number field.
The default numeric value.
Optional inclusive maximum allowed value.
Optional inclusive minimum allowed value.
Whether the field is required.
Optional short label shown after the input (e.g. px, kg).
The type of the field.
MessageTypeListField
#A list field used in a message type.
Attributes
The unique key of the field.
The label of the field.
Settings for the list field.
The default value of the list field.
A JSON schema used to validate the structure of each item in the list. Must be a valid JSON schema.
Whether the field is required.
The type of the field.
RecipientReference
#A recipient reference, used when referencing a recipient by either their ID (for a user), or by a reference for an object.
Attributes
A recipient reference, used when referencing a recipient by either their ID (for a user), or by a reference for an object.
GoalAttachment
#Attaches a goal to a workflow, guide, or broadcast for attribution tracking.
Attributes
The number of days to attribute conversions after the notification is sent. Must be between 1 and 30. Defaults to 7.
The key of the goal to attach.