Skip to content

Update Signature Settings

PUT
/signatures/settings

Replace the signature policy.

Enabling management requires a default template; enforced additionally requires every active mailbox to already have an assignment. Send the version you read — a concurrent change answers 409.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Replace the org-wide signature policy. Optimistic-concurrency checked.

object
data
required

Org-wide signature policy document. Same contract as the in-app editor.

object
allow_employee_overrides
boolean
default: true
cold_sends_variant
string
default: compact
Allowed values: full compact
default_template_id
Any of:
string format: uuid
department_templates
object
key
additional properties
string format: uuid
mode
string
default: off
Allowed values: off default enforced
native_enabled
boolean
version
required

Version you last read. A mismatch is a 409.

integer

Responses

200

Successful Response

object
data
required
object
data
required

The stored policy document.

object
key
additional properties
any
version
required

Version after the write; pass it to the next update.

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