Subscriber Topic Subscriptions

You are here: Communications Cloud API v1 > Resources > Subscribers > Subscriber Topic Subscriptions

Subscriber Topic Subscriptions

Using the subscriber resource, you can manage topic subscriptions for your subscriber base. This resource allows for bulk topic subscription operations. Note that we also offer a Subscriptions resource, for adding or removing individual topic subscriptions for a subscriber.

Methods

Click to view

Method	Description	Required Permissions
List Topic Subscriptions	You can return a list of topics to which a subscriber has subscribed if you need to display this information somewhere, like on a custom subscriber profile page, or if you need this information for another reason--for example, if your subscriber resides in two or more lists within your database and you need to make sure their topic subscriptions in the other lists in your system match the list in GovDelivery.	List Subscriber Topics
Change Topic Subscriptions	Use this call to completely change a subscriber's list of topic subscriptions. This is a bulk operation, which will completely replace the subscriber's current list of topic subscriptions. If you simply want to add new subscriptions, consider using the Add Subscriptions method.	Update Subscriber Topics

Elements

Was this page helpful? Can't find what you need? Let us know

Open topic with navigation

<topics>	This field must include the type="array" attribute. Enter a list of topics for which you want the subscriber to be subscribed. The list of topics you include will completely replace the existing list of topic subscriptions currently set for the subscriber. To delete all topic subscriptions, include and empty topics array. You will enter any topic you want to include in each nested <topic> field.
<topic>	You can include multiple <topic> fields in your input; one for each topic for which the subscriber should be subscribed.
<code>	Enter the code of the topic for which the subscriber will receive updates. This field must be nested in a <topic> field, under the <topics> field.
<send-notifications>	This field requires a value of either True or False and the type="boolean" attribute. Set this field to true send an email notification to the subscriber that their record has been updated.