Clerk API (unofficial showcase)
PUT/templates/{template_type}/{slug}Deprecated

Update a template for a given type and slug

Updates the existing template of the given type and slug

2 parameters · 7 body fields
template_typestringrequired
The type of template to update
Allowed:emailsms
slugstringrequired
The slug of the template to update
namestringoptional
The user-friendly name of the template
subjectstringoptional
The email subject. Applicable only to email templates.
markupstringoptional
The editor markup used to generate the body of the template
bodystringoptional
The template body before variable interpolation
delivered_by_clerkbooleanoptional
Whether Clerk should deliver emails or SMS messages based on the current template
from_email_namestringoptional
The local part of the From email address that will be used for emails. For example, in the address 'hello@example.com', the local part is 'hello'. Applicable only to email templates.
reply_to_email_namestringoptional
The local part of the Reply To email address that will be used for emails. For example, in the address 'hello@example.com', the local part is 'hello'. Applicable only to email templates.

9 status codes
200Success
idstringoptional
objectstringoptional
String representing the object's type. Objects of the same type share the same value.
Allowed:template
instance_idstringoptional
The ID of the instance to which the template belongs
resource_typestringoptional
whether this is a system (default) or user overridden) template
template_typestringoptional
whether this is an email or SMS template
namestringoptional
user-friendly name of the template
slugstringoptional
machine-friendly name of the template
positionintegeroptional
position with the listing of templates
can_revertbooleanoptional
whether this template can be reverted to the corresponding system default
can_deletebooleanoptional
whether this template can be deleted
can_edit_bodybooleanoptional
whether the body of this template can be edited
can_togglebooleanoptional
whether this template can be enabled or disabled, true only for notification SMS templates
subjectstringoptional
email subject
markupstringoptional
the editor markup used to generate the body of the template
bodystringoptional
the template body before variable interpolation
available_variablesarray<string>optional
list of variables that are available for use in the template body
required_variablesarray<string>optional
list of variables that must be contained in the template body
from_email_namestringoptional
reply_to_email_namestringoptional
delivered_by_clerkbooleanoptional
enabledbooleanoptional
flagged_as_suspiciousbooleanoptional
updated_atintegeroptional
Unix timestamp of last update.
created_atintegeroptional
Unix timestamp of creation.
400Request was not successful
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
401Authentication invalid
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
402Payment required
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
403Request was not successful
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
404Resource not found
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
422Invalid request parameters
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
423Locked
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
429Too many requests
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 400 is returned: Request was not successful. A 401 is returned: Authentication invalid. A 402 is returned: Payment required. A 403 is returned: Request was not successful. A 404 is returned: Resource not found. A 422 is returned: Invalid request parameters. A 423 is returned: Locked. A 429 is returned: Too many requests.