mirror of
https://github.com/LukeHagar/clerk-sdk-java.git
synced 2025-12-09 20:37:48 +00:00
28 lines
11 KiB
Markdown
28 lines
11 KiB
Markdown
# Template
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description |
|
|
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
|
| `id` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
|
|
| `object` | [Optional<? extends com.clerk.backend_api.models.components.TemplateObject>](../../models/components/TemplateObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value.<br/> |
|
|
| `instanceId` | *JsonNullable<? extends String>* | :heavy_minus_sign: | the id of the instance the template belongs to |
|
|
| `resourceType` | *Optional<? extends String>* | :heavy_minus_sign: | whether this is a system (default) or user overridden) template |
|
|
| `templateType` | *Optional<? extends String>* | :heavy_minus_sign: | whether this is an email or SMS template |
|
|
| `name` | *Optional<? extends String>* | :heavy_minus_sign: | user-friendly name of the template |
|
|
| `slug` | *Optional<? extends String>* | :heavy_minus_sign: | machine-friendly name of the template |
|
|
| `position` | *Optional<? extends Long>* | :heavy_minus_sign: | position with the listing of templates |
|
|
| `canRevert` | *Optional<? extends Boolean>* | :heavy_minus_sign: | whether this template can be reverted to the corresponding system default |
|
|
| `canDelete` | *Optional<? extends Boolean>* | :heavy_minus_sign: | whether this template can be deleted |
|
|
| `canDisable` | *Optional<? extends Boolean>* | :heavy_minus_sign: | whether this template can be disabled, true only for notification SMS templates |
|
|
| `subject` | *JsonNullable<? extends String>* | :heavy_minus_sign: | email subject |
|
|
| `markup` | *Optional<? extends String>* | :heavy_minus_sign: | the editor markup used to generate the body of the template |
|
|
| `body` | *Optional<? extends String>* | :heavy_minus_sign: | the template body before variable interpolation |
|
|
| `availableVariables` | List<*String*> | :heavy_minus_sign: | list of variables that are available for use in the template body |
|
|
| `requiredVariables` | List<*String*> | :heavy_minus_sign: | list of variables that must be contained in the template body |
|
|
| `fromEmailName` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
|
|
| `replyToEmailName` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
|
|
| `deliveredByClerk` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A |
|
|
| `updatedAt` | *Optional<? extends Long>* | :heavy_minus_sign: | Unix timestamp of last update.<br/> |
|
|
| `createdAt` | *Optional<? extends Long>* | :heavy_minus_sign: | Unix timestamp of creation.<br/> | |