Skip to main content
PATCH
Update email account settings

Authorizations

x-api-key
string
header
required

Your API key, from the API keys page of the app.

Path Parameters

mailboxId
number
required

Mailbox identifier

Example:

1

Body

application/json
displayName
string

Mailbox sender display name used in outgoing emails.

Maximum string length: 150
Example:

"Josh Polmer"

warmupDay
number

Current warmup day for this mailbox.

Required range: x >= 1
Example:

1

dailyLimit
number

Maximum warmup emails allowed per day.

Required range: 1 <= x <= 500
Example:

3

status
enum<string>

Warmup profile status. ACTIVE enables warmup, PAUSED disables warmup.

Available options:
ACTIVE,
PAUSED,
COOLDOWN,
BLOCKED
Example:

"ACTIVE"

hourlyLimit
number

Maximum warmup emails allowed per hour.

Required range: 1 <= x <= 100
Example:

1

minuteLimit
number

Maximum warmup emails allowed per minute.

Required range: 1 <= x <= 20
Example:

1

maxDailyLimit
number

Maximum daily warmup limit this mailbox can reach.

Required range: 1 <= x <= 500
Example:

40

increasePerDay
number

How many emails to increase per day during warmup ramp.

Required range: 1 <= x <= 50
Example:

1

disableSlowWarmup
boolean

Whether to disable gradual warmup ramping.

Example:

false

replyRatePercent
number

Percentage of warmup emails that should receive replies.

Required range: 0 <= x <= 100
Example:

30

weekdaysOnly
boolean

Whether warmup emails should only be sent on weekdays.

Example:

true

readEmulation
boolean

Whether to emulate human-like reading behavior.

Example:

true

openRatePercent
number

Percentage of warmup emails to open.

Required range: 0 <= x <= 100
Example:

100

spamProtectionRatePercent
number

Percentage of warmup emails to rescue from spam.

Required range: 0 <= x <= 100
Example:

100

markImportantRatePercent
number

Percentage of warmup emails to mark as important.

Required range: 0 <= x <= 100
Example:

100

dailyCampaignLimit
number | null

Daily campaign sending limit for this mailbox, across every campaign it belongs to. Send null to clear it; omitting the property leaves the stored value unchanged.

Required range: 1 <= x <= 500
Example:

15

minimumWaitTime
number | null

Minimum minutes between campaign sends from this mailbox, across every campaign it belongs to. Send null to clear it; omitting the property leaves the stored value unchanged.

Required range: 1 <= x <= 1440
Example:

5

campaignSlowRamp
boolean

Gradually increase campaign emails sent per day.

Example:

false

replyToAddress
string | null

Reply-to address for campaign emails. Empty clears it.

Example:

"replies@example.com"

inboxPlacementLimit
number

Number of inbox placement test emails.

Required range: 1 <= x <= 500
Example:

10

warmCustomTrackingDomain
boolean

Whether this mailbox uses a custom tracking domain.

Example:

false

trackingDomain
string | null

Custom tracking domain hostname. Empty clears it.

Example:

"inst.example.com"

Response

Email account settings updated successfully

success
boolean
required
Example:

true

message
string
required
Example:

"Email account settings updated successfully"

data
object
required