Update a Subscriber

You are here: Communications Cloud API v1 > Resources > Subscribers > Update a Subscriber

Update a Subscriber

PUT to /api/account/ACCOUNT_CODE/subscribers/ENCODED_SUBSCRIBER_ID.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

For an email subscriber OR a wireless subscriber changing to an email subscriber

<subscriber>
    <email>EMAIL@ADDRESS.COM</email>
    <send-notifications type='boolean'>false</send-notifications>
    <digest-for>#</digest-for>
  </subscriber>

For a wireless subscriber OR an email subscriber changing to a wireless subscriber

 <subscriber>
    <phone>###-###-####</email>
    <country-code>#</country-code>
    <send-notifications type='boolean'>false</send-notifications>
  </subscriber>

Elements

Changing Subscriber Type

If you want to change the subscriber type (email subscriber vs. wireless subscriber), use their current ID for the ENCODED_SUBSCRIBER_ID in the call and provide the new information (phone + country code vs. email address) in the request body, excluding the existing ID information in the request body. See examples below.

Example Output

<?xml version='1.0' encoding='UTF-8'?>
<subscriber>
  <to-param>SUBSCRIBER_ID</to-param>
  <link rel="self" href="/api/account/ACCOUNT_CODE/subscribers/SUBSCRIBER_ID" />
</subscriber>

Troubleshooting

Reference subscriber error codes

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

Open topic with navigation

<email>	The subscriber's email address.
<phone>	The subscriber's phone number.
<country-code>	The subscriber's country code. You can leave this blank to use the default country code set for your account, although we highly recommend setting the code (1 for United States, 44 for United Kingdom). To check the country code for your account, contact support@granicus.com.
<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.
<digest-for>	This field requires a number value and the type="integer" attribute. Use it to set the frequency for how often the subscriber receives bulletins. Possible values are: 0 - send bulletins immediately 1 - send bulletins daily 7 - send bulletins weekly
<id>	This field indicates the subscriber ID. Omit it from the input to allow the system to generate the subscriber's ID. If you include the field in your input, it requires a number value and the type="integer" attribute. If you set the value to an ID that has already been used, the call will return an error.
<link>	The link fields return URIs to see additional information about the subscriber, such as their category subscriptions, topic subscriptions, etc.