Topics
PUT
Update Topic
PUT /v1/topics/{topicId}Update an existing topic's name, description, or settings.
Use Cases:
- Rename topics for better clarity
- Update topic descriptions as content strategy changes
- Change visibility settings (public/private)
- Refine topic slugs for better URLs
- Update topic metadata
Behavior:
- Only provided fields are updated (partial updates supported)
- Slug can be updated but must remain unique
- Cannot change if it would create slug conflict
- UpdatedAt timestamp is automatically refreshed
- Subscriber count is not affected by updates
- Returns the complete updated topic object
Required Scope: write:topics
Updatable Fields:
- name (display name)
- description (what subscribers will receive)
- slug (URL-safe identifier, must be unique)
- isPublic (visibility in preference centers)
Note: Changing the slug will affect URLs in preference centers and unsubscribe pages. Update your integrations accordingly.
Path parameters
topicIdstringrequiredTopic ID
Bodyrequired
namestringMin length: 1Max length: 100
descriptionanyvisibility"PUBLIC" | "PRIVATE"defaultOptInbooleanResponse
200Topic updated successfully with refreshed updatedAt timestamp
objectstringrequiredidstringrequirednamestringrequireddescriptionanyrequiredvisibility"PUBLIC" | "PRIVATE"requireddefaultOptInbooleanrequired