Skip to content
Extrovert Extrovert Docs

Update signature preferences with optimistic concurrency

PATCH
/v1/admin/orgs/{org_id}/projects/{project_id}/signatures

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
org_id
required
string
project_id
required
string

Concrete project ID or ’-’ for the organization.

Query Parameters

Section titled “Query Parameters ”
address
string

Inbox address. Omit for account settings.

Request Body required

Section titled “Request Body required ”
object
account_version
required
integer format: int64
>= 1
inbox_version
required
integer format: int64
custom_text
string
<= 2000 characters
custom_enabled
boolean
override
string
Allowed values: default on off
account_default
boolean
clear_overrides

Reset all inbox exceptions to the account default. Requires billing account authority.

boolean

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Signature state

Saved preferences and effective signature policy. Custom signatures are plain text, at most 2000 Unicode characters.

object
account_id
required
string
account_name
required
string
account_default
required
boolean
account_version
required
integer format: int64
inbox_id
required
string
address
required
string
custom_text
required
string
<= 2000 characters
custom_enabled
required
boolean
override
required
string
Allowed values: default on off
inbox_version
required
integer format: int64
paid
required
boolean
effective
required
boolean
can_edit_inbox
required
boolean
can_edit_account
required
boolean
preview
required

Example footer text. Delivery-time provenance may choose different attribution.

string

400

Section titled “400 ”

Invalid request.

The canonical error envelope. error is a stable machine code.

object
error
required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string
Example
forbidden
message

Human-readable detail (never leaks internals).

string
Example
missing required scope
reason

Machine-readable quota reason. inbox_limit_exceeded means billing account inbox capacity across all organizations and projects sharing that account; enrollment_token_mailbox_budget_exhausted means the enrollment key lifetime creation allowance. Read message for recovery; inbox counts are separate from sending quotas.

string
used

Consumed plus reserved units.

integer format: int64
delta

Requested additional units.

integer format: int64
limit
integer format: int64
remaining
integer format: int64
consumed
integer format: int64
reserved
integer format: int64
next_reset_at

Next UTC usage-period boundary; pending reservations survive this boundary.

string format: date-time
upgrade_required
boolean

403

Section titled “403 ”

Authenticated but lacking the required scope, or out of quota.

The canonical error envelope. error is a stable machine code.

object
error
required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string
Example
forbidden
message

Human-readable detail (never leaks internals).

string
Example
missing required scope
reason

Machine-readable quota reason. inbox_limit_exceeded means billing account inbox capacity across all organizations and projects sharing that account; enrollment_token_mailbox_budget_exhausted means the enrollment key lifetime creation allowance. Read message for recovery; inbox counts are separate from sending quotas.

string
used

Consumed plus reserved units.

integer format: int64
delta

Requested additional units.

integer format: int64
limit
integer format: int64
remaining
integer format: int64
consumed
integer format: int64
reserved
integer format: int64
next_reset_at

Next UTC usage-period boundary; pending reservations survive this boundary.

string format: date-time
upgrade_required
boolean

409

Section titled “409 ”

Resource conflict (e.g. a duplicate entry).

The canonical error envelope. error is a stable machine code.

object
error
required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string
Example
forbidden
message

Human-readable detail (never leaks internals).

string
Example
missing required scope
reason

Machine-readable quota reason. inbox_limit_exceeded means billing account inbox capacity across all organizations and projects sharing that account; enrollment_token_mailbox_budget_exhausted means the enrollment key lifetime creation allowance. Read message for recovery; inbox counts are separate from sending quotas.

string
used

Consumed plus reserved units.

integer format: int64
delta

Requested additional units.

integer format: int64
limit
integer format: int64
remaining
integer format: int64
consumed
integer format: int64
reserved
integer format: int64
next_reset_at

Next UTC usage-period boundary; pending reservations survive this boundary.

string format: date-time
upgrade_required
boolean