Skip to content

Preview Signature Setup

POST
/signatures/setup-preview

Dry-run an assignment against the mail provider before committing it.

Confirms the employee account and send-as alias resolve, and returns the signature currently installed there. Write capability stays unverified until a real deployment succeeds. A provider refusal answers 422 with the state and reason rather than a stack trace.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Check that a mailbox’s provider account and send-as alias are usable.

object
data
required

Which employee a mailbox signs as, and which template it renders.

object
account_subject
required
string
>= 3 characters <= 255 characters
integration_id
Any of:
string format: uuid
member_id
required
string format: uuid
native_requested
boolean
overrides
object
key
additional properties
string
send_as_email
required
string
>= 3 characters <= 255 characters
template_id
Any of:
string format: uuid
mailbox_id
required
integer

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