Topics

Create a topic

Create a subscription topic — a category recipients can opt out of on their own (e.g. Promotions) while staying on your list. default_opt_in decides whether contacts with no explicit preference are treated as subscribed. Scope a campaign to a topic so opted-out contacts are skipped automatically via Create a campaign, and set an individual contact's preference with Set a contact's topic preference. Topics differ from segments: a segment decides who a campaign targets, a topic lets recipients opt out. Requires the topics:write capability.

post/email/topics

Request

  • Base URL: https://www.unitpost.com/api/v1
  • URL: https://www.unitpost.com/api/v1/email/topics
  • Auth: HTTP bearer

Request body

namestring required
descriptionstring
default_opt_inboolean

Response

Created.

object'topic' required
idstring required
namestring required
descriptionstring nullable required
channel'email' | 'sms' required

Which channel the topic belongs to. Email topics are managed under /email/topics, SMS topics under /sms/topics.

default_opt_inboolean required
created_atstring required
updated_atstring required

Changes

No recorded changes to this operation across all 1 revision of this API.