Skip to content

Preview Signature Template

POST
/signatures/preview

Render an unsaved template draft. Reads only — nothing is saved or sent.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Render an unsaved template draft.

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}$/
mailbox_id
Any of:
integer
member_id
Any of:
string format: uuid
overrides
object
key
additional properties
string

Responses

200

Successful Response

object
data
required
object
key
additional properties
any
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