Skip to content

Create Signature Template

POST
/signatures/templates

Create a signature template.

The block list is validated the way the in-app editor validates it: exactly one required, locked identity block, at most one optional banner slot, unique block ids. A rejected template answers 422 with the reason.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Create or update a signature template.

object
data
required

A signature template’s blocks, layout and branding.

object
blocks
required
Array<object>
>= 1 items <= 30 items
object
id
required
string
/^[a-zA-Z0-9_-]{1,64}$/
image
string
"" <= 2048 characters
kind
required
string
Allowed values: identity contact photo logo social cta banner divider disclaimer green_footer custom_html
locked
boolean
required
boolean
text
string
"" <= 10000 characters
url
string
"" <= 2048 characters
brand_source
string
default: brand_kit
Allowed values: brand_kit custom
font
string
default: Arial
Allowed values: Arial Verdana Georgia Tahoma
layout
string
default: classic-stacked
Allowed values: classic-stacked photo-left logo-left two-column compact-inline banner-hero
name
required
string
>= 1 characters <= 150 characters
primary_color
string
default: #222222 /^#[a-fA-F0-9]{6}$/
version

Version you last read. Ignored on create.

integer

Responses

201

Successful Response

object
data
required
object
data
required

The stored template document.

object
key
additional properties
any
id
required
string
version
required
integer
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string