Success
| Field | Type | Required | Description |
|---|---|---|---|
id |
Optional<String> | ➖ | N/A |
object |
Optional<TemplateObject> | ➖ | String representing the object's type. Objects of the same type share the same value. |
instanceId |
JsonNullable<String> | ➖ | the id of the instance the template belongs to |
resourceType |
Optional<String> | ➖ | whether this is a system (default) or user overridden) template |
templateType |
Optional<String> | ➖ | whether this is an email or SMS template |
name |
Optional<String> | ➖ | user-friendly name of the template |
slug |
Optional<String> | ➖ | machine-friendly name of the template |
position |
Optional<Long> | ➖ | position with the listing of templates |
canRevert |
Optional<Boolean> | ➖ | whether this template can be reverted to the corresponding system default |
canDelete |
Optional<Boolean> | ➖ | whether this template can be deleted |
canToggle |
Optional<Boolean> | ➖ | whether this template can be enabled or disabled, true only for notification SMS templates |
subject |
JsonNullable<String> | ➖ | email subject |
markup |
Optional<String> | ➖ | the editor markup used to generate the body of the template |
body |
Optional<String> | ➖ | the template body before variable interpolation |
availableVariables |
List<String> | ➖ | list of variables that are available for use in the template body |
requiredVariables |
List<String> | ➖ | list of variables that must be contained in the template body |
fromEmailName |
Optional<String> | ➖ | N/A |
replyToEmailName |
Optional<String> | ➖ | N/A |
deliveredByClerk |
Optional<Boolean> | ➖ | N/A |
enabled |
Optional<Boolean> | ➖ | N/A |
updatedAt |
Optional<Long> | ➖ | Unix timestamp of last update. |
createdAt |
Optional<Long> | ➖ | Unix timestamp of creation. |