SMS topics

Update an SMS topic

Update an SMS topic's name, description or default_opt_in, or pass { "archived": true | false } to archive or restore it. Archiving is blocked with 409 while an active SMS campaign or a live automation still uses the topic. Requires the topics:write capability.

patch/sms/topics/{id}

Request

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

Request body

namestring
descriptionstring nullable
default_opt_inboolean

Response

The updated SMS 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.