Categories

You are here: Communications Cloud API v1 > Resources > Categories

Categories

Categories are used to divide subscription topics into an organized, hierarchical structure. Categories can contain topics or even other categories (sub-categories). You can also specify lists of subscribers for a category.

Methods

Click to view

Method	Description	Required Permissions
Create a Category	When you POST to the category resource, a category is created. Using this method, you specify category options, like whether people can subscribe to it and if it's nested under a parent category. Once the category is created, topics can be added to it and bulletins can be created under this category.	Create Category
Read a Category	A GET call to a specific category resource will return details about that category. This lets you display the category on a website or in a form and also see information about the category.	Read Category
Update a Category	You can update a category, making changes to it like giving it a new short name or putting it under another parent category.	Update Category
Delete a Category	Delete a category from your account by sending a DELETE to a particular category resource. Before you delete a category, keep in mind that any subscribers who are only subscribed to this category may be loss and that the reporting data associated with this category will be affected.	Delete Category
List Categories	To see all the categories currently available for your account, send a GET operation to the category resource. You can see details for each category in the list. You might use this method to display categories on a web page or form.	List Category
List a Category's Topics	Use this GET method to see a list of topics for a particular category.	List Category Topics

Elements

Click to view

Note: Fields with an asterisk (*) are required.

<allow-subscriptions>	This field requires a value of either True or False and the type="boolean" attribute. Set this field to true if you want users to be able to subscribe to this category. Users subscribed to a category receive updates for all topics assigned to that category. GovDelivery recommends that high-interest categories be offered for subscription.
<code>	A code is systematically assigned by GovDelivery when a category is created in the administrative interface. When creating a category via the API, you choose the code, or leave it blank to have it be system-generated. Any code you choose must be unique (i.e., not used by an existing category). This code can be changed by an administrator to anything that benefits their organizational purposes.
<default-open>	This field requires a value of either True or False and the type="boolean" attribute. Set this field to true to have this category expanded by default on the Quick Subscribe page. An open/expanded category displays all subcategories and topics that reside within it.
<description>	Description of the category. This is optional, but recommended. Category descriptions can be seen by subscribers on your organization's subscription pages, giving them more information about the updates they'll receive. Because this field can be left empty, the nil="true" attribute is required.
<name>*	Name of the category. This name is for internal purposes and is not displayed to the public.
<short-name>*	A short version of the category's name. This is the name that subscribers will see and can be modified for organizational purposes.
<parent>	If you want this category to be created as a child to another category (i.e., it will be nested underneath that category), include this element with a nested <code> element that contains the code of the parent category.
<qs_page>	You can specify a Quick Subscribe page to display when someone subscribes to this category. Include the code for the Quick Subscribe page in a nested <code> element. The page's code can be found in the administrative interface. If this element is excluded, the default Quick Subscribe page is used for this category.

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

Open topic with navigation