Topics

A topic is a lasting editorial theme a reader can decline on its own, without unsubscribing from everything. It belongs to the organization, and a campaign or a sequence carries zero or one. Every other topic call takes an id, never a name: POST /api/v1/topics and GET /api/v1/topics are where that id comes from. Attach it with topicId when you create or edit a campaign, or when you edit a sequence.

The loop, end to end

  1. Read or create the topic. GET /api/v1/topics lists them; POST /api/v1/topics adds one.
  2. Attach it. topicId on POST /api/v1/campaigns, on PATCH /api/v1/campaigns/{campaignId} or on PATCH /api/v1/sequences/{sequenceId}.
  3. Offer the exit. Put {{topicOptOutUrl}} in the content, next to the unsubscribe link. Without a topic on the send, that shortcode makes the send refused — the link would be dead.
  4. Honour refusals. A reader clicking it is dropped from that topic. You can also record one yourself with Opt a contact out of a topic.
See What a topic does for the rules behind all this.