Skip to main content
PATCH
Update email address settings

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
sender_name
string | null
Maximum string length: 100
auto_reply_enabled
boolean
auto_reply_message
string
Maximum string length: 2000
is_broadcast_default
boolean
forwarded_email_handling
enum<string>
Available options:
AUTO,
ORIGINAL_SENDER,
FORWARDER

Response

Successful response

id
string
required
email
string
required
domain
string
required
inbound_address
string
required
sender_name
string | null
required
auto_reply_sender_name
string | null
required
is_enabled
boolean
required
is_primary
boolean
required
is_broadcast_default
boolean
required
is_forwarding_setup
boolean
required
auto_reply_enabled
boolean
required
auto_reply_message
string
required
ai_agent_enabled
boolean
required

Read-only. True when the agent is enabled and its email channel is on. Set it under the agent settings, not per address.

forwarded_email_handling
string
required

One of AUTO, ORIGINAL_SENDER, FORWARDER.

dns_txt_verified
boolean
required
dns_cname_verified
boolean
required
created_at
string
required
updated_at
string
required