mirror of
https://github.com/LukeHagar/clerk-sdk-java.git
synced 2025-12-06 12:27:45 +00:00
11 KiB
11 KiB
Template
Fields
| Field | Type | Required | Description |
|---|---|---|---|
id |
Optional<? extends String> | ➖ | N/A |
object |
Optional<? extends com.clerk.backend_api.models.components.TemplateObject> | ➖ | String representing the object's type. Objects of the same type share the same value. |
instanceId |
JsonNullable<? extends String> | ➖ | the id of the instance the template belongs to |
resourceType |
Optional<? extends String> | ➖ | whether this is a system (default) or user overridden) template |
templateType |
Optional<? extends String> | ➖ | whether this is an email or SMS template |
name |
Optional<? extends String> | ➖ | user-friendly name of the template |
slug |
Optional<? extends String> | ➖ | machine-friendly name of the template |
position |
Optional<? extends Long> | ➖ | position with the listing of templates |
canRevert |
Optional<? extends Boolean> | ➖ | whether this template can be reverted to the corresponding system default |
canDelete |
Optional<? extends Boolean> | ➖ | whether this template can be deleted |
canDisable |
Optional<? extends Boolean> | ➖ | whether this template can be disabled, true only for notification SMS templates |
subject |
JsonNullable<? extends String> | ➖ | email subject |
markup |
Optional<? extends String> | ➖ | the editor markup used to generate the body of the template |
body |
Optional<? extends 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<? extends String> | ➖ | N/A |
replyToEmailName |
Optional<? extends String> | ➖ | N/A |
deliveredByClerk |
Optional<? extends Boolean> | ➖ | N/A |
updatedAt |
Optional<? extends Long> | ➖ | Unix timestamp of last update. |
createdAt |
Optional<? extends Long> | ➖ | Unix timestamp of creation. |