Topics

Update a topic

Update a topic's name or default_opt_in behavior, or pass { "archived": true | false } to archive or restore it. Archiving a topic hides it and stops it from being targeted, but is blocked with 409 while an active campaign still targets it. To manage a single contact's preference, use Set a contact's topic preference. Requires the topics:write capability.

patch/email/topics/{id}

Request

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

Request body

namestring
descriptionstring nullable
default_opt_inboolean

Response

The updated topic.

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.