Subscriber Information

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

Subscriber Information

The subscriber resource allows you to manage your subscriber base, adding, updating, and deleting subscribers. You can also manage individual subscriber information like name or email address.

Methods

Click to view

Method	Description	Required Permissions
Create a Subscriber	Create a subscriber by sending a POST operation to the Subscribers resource. This allows you to create a subscriber from outside of GovDelivery, for example, using a form submitted on your website.	Create Subscriber
Read a Subscriber	To see details about a subscriber, like their email address, use a GET operation. This will return a list of links that you can use to look up their topic subscriptions, category subscriptions, and security question responses.	Read Subscriber
Update a Subscriber	Update a subscriber by sending a PUT operation to the specific subscriber resource. This allows you to accept changes to subscriber information from forms on your website or to push changes made in a separate subscriber database.	Update Subscriber
Delete a Subscriber	Send delete operations to specific subscriber resources. You might use this method along with a script that searches your subscriber email addresses for known spam domains.	Delete Subscribers

Elements

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.