team
Stable
Latest stable
Role changed v1
role-changed - v1
Subject: Role changed
Preheader: A team member's role has changed.
Required fields
No fields.
Optional fields
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
actionButton.label |
text | No | Action Button Label Max 120 characters |
View team |
actionButton.url |
url | No | Action Button URL Max 2048 characters |
https://example.com/app |
heading |
text | No | Heading Max 180 characters |
Role changed |
intro |
text | No | Intro Max 1000 characters |
A team member's role has changed. |
preheader |
text | No | Preheader Max 220 characters |
A team member's role has changed. |
roleDetails |
detailsTable | No | Role details Details table keys: member, previousRole, newRole, changedAt (datetime) |
{"member":"Member","previousRole":"Previous Role","newRole":"New Role","changedAt":"Changed At"} |
subject |
text | No | Subject Max 180 characters |
Role changed |
Defaults
{
"actionButton.label": "View team",
"heading": "Role changed",
"intro": "A team member's role has changed.",
"preheader": "A team member's role has changed.",
"subject": "Role changed"
}
Example data
{
"templateId": "role-changed",
"data": {}
}
Template messages
| Type | Code | Message |
|---|---|---|
| Return | accepted |
Valid template data can be queued by the send endpoint. |
| Error | field_too_long |
Action Button Label must be 120 characters or fewer. |
| Error | field_too_long |
Action Button URL must be 2048 characters or fewer. |
| Error | invalid_url |
Action Button URL must be a valid http or https URL. |
| Error | field_too_long |
Heading must be 180 characters or fewer. |
| Error | field_too_long |
Intro must be 1000 characters or fewer. |
| Error | field_too_long |
Preheader must be 220 characters or fewer. |
| Error | invalid_details_table |
Role details must be an object whose documented table keys are strings, numbers, or booleans. |
| Error | field_too_long |
Subject must be 180 characters or fewer. |