Warmup

Update warmup settings

Enable/disable warmup, switch strategy, or set the target daily volume for one mailbox. Enabling requires the mailbox status to be "connected". A strategy change updates both warmup_type and warmup_mode (the field the ramp reads). If a faster strategy cannot take effect yet because recent deliverability is poor, the response carries a plain-language meta.warning — the change is recorded, but the safer pace stays in force until placement recovers.

Required scope: warmup:write.

patch/warmup/settings/{mailboxId}

Request

  • Base URL: https://warmysender.com/api/v1
  • URL: https://warmysender.com/api/v1/warmup/settings/{mailboxId}
  • Auth: HTTP bearer

Path parameters

mailboxIdstring required

Mailbox id (UUID).

Request body

warmup_enabledboolean

Turn warmup on or off. Enabling requires the mailbox status to be "connected".

warmup_type'new_domain' | 'new_mailbox' | 'dormant' | 'maintenance' | 'recovery' | 'aggressive' | 'normal' | 'conservative'

Warmup strategy. Controls ramp speed and target.

warmup_target_daily_volumeinteger

Target warmup emails per day once fully ramped.

language'en' | 'es' | 'fr' | 'de' | 'pt' | 'it' | 'nl'

Language the warmup emails are written in (written natively, not translated). Applies to newly written warmup mail; does not reset the ramp or change the volume.

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.