Skip to main content
PATCH
Update an email account

Authorizations

Authorization
string
header
required

Authenticate every request with a Bearer token. Pass your Reply API key in the Authorization header:

Get your API key from the Reply dashboard: Settings → API Key.

Path Parameters

id
integer<int64>
required

Email Account ID

Body

application/json

Request body for partially updating an email account (PATCH). Only provide the sections and fields you want to change. Omitted sections and fields are left unchanged.

connection
EmailAccountConnectionSection · object

SMTP and IMAP connection settings for a custom email account. Only applicable to Custom provider type.

safety
EmailAccountSafetySection · object

Sending safety and throttling configuration.

signature
EmailAccountSignatureSection · object

Email signature configuration.

optOut
EmailAccountOptOutSection · object

Opt-out / unsubscribe link configuration.

rampUp
EmailAccountRampUpSection · object

Sending volume ramp-up configuration for warming up email accounts.

tags
string[]

Tag names to assign (replaces existing tags)

Response

Email account updated successfully

Full detailed representation of an email account, including all configuration sections.

id
integer<int64>
read-only

Unique identifier for the email account

ownerUserId
integer
read-only

ID of the user who owns this email account

emailAccountType
enum<string>
read-only

Provider type of the email account. Values: custom, gmail, outlook, exchange, exchangeOnPremise

Available options:
custom,
gmail,
outlook,
exchange,
exchangeOnPremise
isDefault
boolean
read-only

Whether this is the user's default email account

isInUse
boolean
read-only

Whether this email account is currently used in any active sequence

connectionStatus
enum<string>
read-only

Current connection status of the email account. Values: unknown, connected, disconnected

Available options:
unknown,
connected,
disconnected
sendingConnectivityError
string | null
read-only

Error details if SMTP sending connectivity has failed

receivingConnectivityError
string | null
read-only

Error details if IMAP receiving connectivity has failed

sendingLockedByProvider
boolean
read-only

Whether the email provider has locked outbound sending

updatedAt
string<date-time>
read-only

Timestamp of the last update to this email account

connection
EmailAccountConnectionResponseSection · object

Connection settings returned in responses (passwords excluded).

safety
EmailAccountSafetySection · object

Sending safety and throttling configuration.

signature
EmailAccountSignatureSection · object

Email signature configuration.

optOut
EmailAccountOptOutSection · object

Opt-out / unsubscribe link configuration.

rampUp
EmailAccountRampUpSection · object

Sending volume ramp-up configuration for warming up email accounts.

tags
string[]

Tag names associated with this email account