Update Team Warm-Up Topic Preference

Set the warm-up topics your team uses by default. Every mailbox that inherits from the team (mode: inherit on the mailbox) follows the new value.

  • {"mode": "general"} -> General content only. Send no selections, or [].
  • {"mode": "custom", "selections": [...]} -> draw warm-up content from the selected industries and topics. At least one industry is required.

A team cannot be set to inherit; send general or custom.

Selection rules

  • At most 5 industries, each with 1 to 5 topics. No industry twice, and no topic twice within an industry.
  • selections and every topics value must be JSON arrays (lists), not objects or JSON-encoded strings.
  • Use industry keys and topic names exactly as GET /warmup-topics returns them. Each topic must belong to the industry it is listed under.
  • An industry you add must currently be available: true. An industry already saved on the team can be sent again even while it is available: false.

Replace, not merge

selections replaces the saved selection as a whole. Industries and topics you leave out are removed. 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 changes nothing: you get 200 with the current setting, and no change is recorded.

Access

Only the team owner can call this endpoint.

Body Params
string
enum
required

Required.

  • 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 [] when mode is general.

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.

TEAM_NOT_FOUND -> the team could not be resolved.
  • Not the team owner -> the framework's default body, {"message": "This action is unauthorized."}.
  • WARMUP_TOPICS_NOT_ENABLED -> topic selection is not enabled for this team. Nothing is saved. On this endpoint data carries the team's current setting.
  • 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