Skip to main content
PATCH
Update Self-recovery Config

What you can change

  • enabled — turn self-recovery on or off for the account.
  • monitoredSignals — the signals self-recovery watches. This replaces the current list, so send the full set, not a delta. inboxPlacement requires the inbox-placement test to be active on the account.
  • authorizedActions — the strategies self-recovery may run automatically. This replaces the current list.
  • digestFrequency — how often team admins get the recovery summary email: daily, or weekly on Mondays. It is sent at 8am in the team timezone, and only when self-recovery opened a case.
The first update creates the configuration; digestFrequency starts at daily unless you send it.

Authorized actions

Only fixDns and recover can be authorized:
  • fixDns — pause sending until the DNS records are corrected.
  • recover — cap the daily sending volume and re-warm the mailbox.
provision, replace and listHygiene are diagnosis-only: self-recovery will still recommend them in the history, but it never executes them automatically. Sending any of them in authorizedActions returns 400.

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

All fields are optional; only the supplied fields change. monitoredSignals and authorizedActions replace the current lists (send the full set). Only fixDns and recover may be authorized. The first update creates the configuration, with digestFrequency set to daily unless you send it.

enabled
boolean

Turn self-recovery on or off.

monitoredSignals
enum<string>[]

Replaces the monitored-signals list.

Available options:
bounceRate,
blacklist,
inboxPlacement
authorizedActions
enum<string>[]

Replaces the authorized-actions list. Only fixDns and recover are accepted.

Available options:
fixDns,
recover
digestFrequency
enum<string>

How often team admins get the recovery summary email: daily, or weekly on Mondays.

Available options:
daily,
weekly

Response

Success

config
object

Account-level self-recovery configuration. Self-recovery watches the monitored signals and, when authorized, automatically runs recovery actions on degraded mailboxes.