Skip to content

Assign Signature Template

POST
/signatures/templates/{template_id}/assign

Point a set of mailboxes at this template and queue a re-install.

Targets are mutually exclusive: explicit mailbox_ids, every mailbox whose employee is in department, or all_mailboxes. Every targeted mailbox must already have an employee assignment (422 otherwise).

Authorizations

Parameters

Path Parameters

template_id
required

Signature template id

string format: uuid

Signature template id

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Apply one template across mailboxes. Choose exactly one targeting mode.

object
all_mailboxes

Every active, assigned mailbox.

boolean
department
Any of:
string
mailbox_ids
Array<integer>
<= 1000 items

Responses

200

Successful Response

object
data
required
object
count
required
integer
results
required
Array<object>
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