Skip to main content
PATCH
Update mailbox sender identity

Authorizations

Authorization
string
header
required

Sendmux API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.

Query Parameters

mailbox_id
string

Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.

Body

application/json
html_signature
string | null

HTML signature appended to Mailbox API sends that include html_body.

Maximum string length: 2047
name
string | null

Default sender name. Send null or an empty string to clear it.

Maximum string length: 254
text_signature
string | null

Plain text signature appended to Mailbox API sends that include text_body.

Maximum string length: 2047

Response

Updated mailbox sender identity

meta
object
required
ok
enum<boolean>
required
Available options:
true
data
object
required