Topics

Set a contact's topic preference

Subscribe or unsubscribe a contact for one topic. This records an explicit preference that overrides the topic's default_opt_in, and it's idempotent — setting the same preference twice succeeds. PUT behaves identically. Read the contact's current state with List a contact's topic subscriptions. Requires the topics:write capability.

post/contacts/{id}/topics

Request

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

Request body

topic_idstring
topicstring
subscribedboolean required

Response

The resolved subscription.

object'contact_topic' required
topic_idstring required
channel'email' | 'sms' required

The topic's channel: manage it under /email/topics or /sms/topics.

subscribedboolean required
status'subscribed' | 'unsubscribed' required
source'user' | 'manual' | 'import' | 'api' required

Changes

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