Change Category Subscriptions

You are here: Communications Cloud API v1 > Resources > Subscribers > Change Category Subscriptions

Change Category Subscriptions

PUT to /api/account/ACCOUNT_CODE/subscribers/ENCODED_SUBSCRIBER_ID/categories.xml

Your ACCOUNT_CODE can be found via the administrative interface.

The ENCODED_SUBSCRIBER_ID is the following information run through Base64 conversion:
- For email subscribers: email address.
- For wireless subscribers: a string consisting of country code, a plus (+) sign, and the (digit-only) phone number. Example: 1+5555555555
- The appropriately encoded ID will be returned in the <to-param> element of the output from the Create Subscriber method.

Example Input

Subscriber will have two category subscriptions and will not receive notification of the update

<subscriber>
    <send-notifications type='boolean'>false</send-notifications>
    <categories type='array'>
      <category>
        <code>####</code>
      </category>
      <category>
        <code>####</code>
      </category>
    </categories>
  </subscriber>

All category subscriptions for this subscriber will be removed and subscriber will be notified

<subscriber>
    <categories type='array' />
  </subscriber>

Elements

Output

A successful operation will have a 200 OK response status and an empty response body.

Troubleshooting

Reference subscriber error codes

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

Open topic with navigation

<categories>	This field must include the type="array" attribute. Enter a list of categories for which you want the subscriber to be subscribed. The list of categories you include will completely replace the existing list of category subscriptions currently set for the subscriber. To delete all category subscriptions, include and empty categories array. You will enter any category you want to include in each nested <category> field.
<category>	You can include multiple <category> fields in your input; one for each category for which the subscriber should be subscribed.
<code>	Enter the code of the category for which the subscriber will receive updates. This field must be nested in a <category> field, under the <categories> 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.