template.md

Template

Success

Fields

Field	Type	Required	Description	Example
id	Optional[str]	➖	N/A	temp_12345
object	Optional[models.TemplateObject]	➖	String representing the object's type. Objects of the same type share the same value.	template
instance_id	OptionalNullable[str]	➖	the id of the instance the template belongs to	inst_67890
resource_type	Optional[str]	➖	whether this is a system (default) or user overridden) template	system
template_type	Optional[str]	➖	whether this is an email or SMS template	email
name	Optional[str]	➖	user-friendly name of the template	Welcome Email
slug	Optional[str]	➖	machine-friendly name of the template	welcome_email
position	Optional[int]	➖	position with the listing of templates	1
can_revert	Optional[bool]	➖	whether this template can be reverted to the corresponding system default	false
can_delete	Optional[bool]	➖	whether this template can be deleted	true
can_toggle	Optional[bool]	➖	whether this template can be enabled or disabled, true only for notification SMS templates
subject	OptionalNullable[str]	➖	email subject	Welcome to our service!
markup	Optional[str]	➖	the editor markup used to generate the body of the template	Hello, {{ user.name }}
body	Optional[str]	➖	the template body before variable interpolation	You are now signed up. Welcome!
available_variables	List[str]	➖	list of variables that are available for use in the template body	[ "user.name", "user.email" ]
required_variables	List[str]	➖	list of variables that must be contained in the template body	[ "user.name" ]
from_email_name	Optional[str]	➖	N/A	Clerk Support
reply_to_email_name	Optional[str]	➖	N/A	support@clerk.com
delivered_by_clerk	Optional[bool]	➖	N/A	true
enabled	Optional[bool]	➖	N/A
updated_at	Optional[int]	➖	Unix timestamp of last update.	1610000000
created_at	Optional[int]	➖	Unix timestamp of creation.	1600000000