Update Mailbox Warm-Up Topic Preference

Give a specific mailbox (campaign) its own warm-up topics, or send it back to the team setting.

  • {"mode": "inherit"} -> remove the mailbox's own setting and follow the team. Send no selections.
  • {"mode": "general"} -> General content only for this mailbox, whatever the team uses. Send no selections.
  • {"mode": "custom", "selections": [...]} -> this mailbox uses its own industries and topics. At least one industry is required.

Selection rules

The same rules as the team endpoint: at most 5 industries with 1 to 5 topics each, no duplicates, lists only, names exactly as GET /warmup-topics returns them, and each topic under its own industry.

An industry you add must currently be available: true. Only industries already saved on this mailbox may be sent again while unavailable: an unavailable industry copied from the team setting is rejected.

Replace, not merge

selections replaces the mailbox's saved selection as a whole. Industries keep the order you send; topics within an industry come back in catalogue order. GET leaves out retired topics, so sending a GET response back removes any retired topics from the saved selection. Saving exactly what is already stored, or inherit on a mailbox that already inherits, changes nothing and records no change.

Access

A mailbox outside your team returns 403 CAMPAIGN_NOT_FOUND, before any validation runs.

Path Params
integer
required

Campaign ID.

Body Params
string
enum
required

Required.

  • inherit -> remove the mailbox's own setting and follow the team. selections must be omitted, null or [].
  • general -> General content only. selections must be omitted, null or [].
  • custom -> use selections. At least one industry is required.
Allowed:
selections
array of objects | null

Required when mode is custom. Must be omitted, null or [] otherwise.

selections
Headers
string
required

Any unique string, timestamp, or UUID for logging.

Responses

errors lists the messages per field.

Accept: application/json to get this JSON body.

CAMPAIGN_NOT_FOUND -> the mailbox does not exist or is outside your team.
  • WARMUP_TOPICS_NOT_ENABLED -> topic selection is not enabled for the team this mailbox inherits from. Nothing is saved.
  • GET before you retry.

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