Update an SMS topic

PATCH/api/v1/sms/topics/{id}

PATCH /sms/topics/{id}

curl -X PATCH 'https://www.unitpost.com/api/v1/sms/topics/top_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{ }'

Response · 200

{
  "object": "topic",
  "id": "id_123",
  "name": "Example",
  "description": "string",
  "channel": "email",
  "default_opt_in": false,
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

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.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Request body3 fields

Field	Type	Description
`name`	string	—
`description`	string \| null	—
`default_opt_in`	boolean	—

Response · 200 fields8 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`description`required	string \| null	—
`channel`required	enumemail \| sms	Which channel the topic belongs to. Email topics are managed under `/email/topics`, SMS topics under `/sms/topics`.
`default_opt_in`required	boolean	—
`created_at`required	string	—
`updated_at`required	string	—

200401403404409422

Update an SMS topic

Update an SMS topic

Search docs and guides