Skip to main content
PUT
Update a template

Authorizations

x-token
string
header
required

Path Parameters

id
string
required

Template ID.

Body

application/json
name
string
required
description
string
required
templateType
enum<string>
required

Template kind. blockDocument is not accepted — it is an internal type for document blocks, not a user-facing template.

Available options:
sms,
email,
form,
eSignature,
pdf
subject
string
required

Email subject, or the file name for a pdf template — in which case filename-illegal characters are stripped. Merge placeholders work here too, and are shape-checked the same way.

content
string
required

Template body. Merge placeholders take the form {{value}} or {{value || fallback: text}}, where value is an item's value from GET /api/board/{boardId}/merge-fields — for example {{firstname}}, {{Locations["Rent"] || fallback: TBD}}. They are checked for shape — an unclosed {{, an empty field name or a malformed bracket reference is rejected. Whether each field exists is not checked: an unknown one renders as its fallback at merge time.

companyId
string

Required with a partner token; resolved from an API key or delegate token.

userId
string

The acting user. Required with an API key or partner token; a delegate token supplies its own.

htmlBuilder
enum<boolean>
default:false

Must be false or omitted. HTML-builder templates keep their markup in a builder-owned builderData format and can only be authored in the app.

Available options:
false
builderData
object

Builder document, when one already exists.

folderId
string

Library folder the template belongs to — must be an existing, non-archived folder in the company. Governs who may edit the template.

aptletUuid
string

Board the template is scoped to. Must be an existing, non-archived board in the company.

signature
string
attachmentIds
string[]

Uploaded file ids to attach.

Response

Template updated.

data
object