Skip to content

Assign Signature Identity

POST
/signatures/assignments

Bind an employee identity to mailboxes and queue the first install.

This is a TAKEOVER: the mailbox’s existing signature is captured for restore and replaced, which is why confirm_takeover must be true. Every mailbox id must appear in expected_revisions (use 0 for a mailbox with no assignment yet) so a stale client cannot clobber a concurrent change.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Bind an employee identity to one or more mailboxes.

confirm_takeover must be true: assignment replaces whatever signature those mailboxes send today, and the original is captured for restore.

object
confirm_takeover
required

Must be true. Acknowledges that the mailbox’s current signature is replaced.

boolean
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
expected_revisions
required

Mailbox_id -> revision you last read. Use 0 for a mailbox with no assignment yet.

object
key
additional properties
integer
mailbox_ids
required
Array<integer>
>= 1 items <= 1000 items

Responses

200

Successful Response

object
data
required
Array<object>
object
mailbox_id
required
integer
revision
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