Update Mailbox Warm-Up Audience Preference

Override or inherit the warm-up audience for a specific mailbox (campaign).

Use this endpoint to:

  • Pin a mailbox to all, business, or consumer (override the team setting), or
  • Send inherit to remove the mailbox override and fall back to the team-wide setting.
Path Params
integer
required

Campaign ID.

Body Params
string
enum
required

Required.

  • all -> warm up with both business and consumer mailboxes.
  • business -> warm up with business mailboxes only.
  • consumer -> warm up with consumer mailboxes only.
  • inherit -> remove the mailbox override and follow the team-level setting.
Allowed:
Headers
string
required

Any unique string, timestamp, or UUID for logging.

Responses

400

Validation error

401

Unauthorized - Invalid or missing API token

403

Campaign not found or not accessible

all and cannot be changed. No value is stored, and any previously stored preference is left untouched.

500

Failed to update warm-up audience preferences

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json