Get Mailbox Warm-Up Topic Preference

Get the warm-up topic setting for a specific mailbox (campaign): its own setting, the team setting it falls back to, and the value actually in effect.

  • mode / selections -> the mailbox's own setting. inherit means it has none and follows the team.
  • team_mode / team_selections -> the team setting this mailbox inherits from.
  • effective_mode / effective_selections -> the setting in effect after inheritance: the mailbox's own setting, otherwise the team's.
  • effective_source -> where the effective value comes from: campaign (its own setting), team (the team setting) or none (nothing saved anywhere, so General content).

A mailbox inherits from its owner's team. When that is a team you cannot view (for example, the mailbox belongs to a member of your team who owns a separate team), team_mode and team_selections are null. If the mailbox also has no setting of its own, effective_mode and effective_selections are null too and effective_source is team.

Selections leave out retired topics. A custom setting whose topics have all been retired sends General content, so effective_mode reads general while mode (or team_mode) still reads custom with [].

The content actually sent also depends on each industry being available: a saved industry that is temporarily unavailable stays in the setting but is not used until it is available again.

A mailbox outside your team returns 403 CAMPAIGN_NOT_FOUND.

Path Params
integer
required

Campaign ID.

Headers
string
required

Any unique string, timestamp, or UUID for logging.

Responses

Accept: application/json to get this JSON body.

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