Subscription Categories

Subscription categories are the different types of subscriptions that a member can be subscribed to. This can include email, SMS, and other contact methods.

Subscription Category

The subscription category is a type of subscription that a member can subscribe to. Each subscription category has a name and a list of channels. The channels are the contact methods that the member can subscribe to for the subscription category.

Example

An example of a subscription category is Promotions. This subscription category might have two channels, email and sms. This means that a member can subscribe to the Promotions subscription category and select to receive emails and/or SMS messages.

id
required
string (SubscriptionCategoryID)

The unique identifier for a subscription category.

name
required
string

The name of the subscription category.

channels
required
Array of strings (Channel)

The channels that are available for the subscription category. The available channels are setup by the Movio team.

Items Enum: "EMAIL" "SMS"
{
  • "id": "newsletters",
  • "name": "Newsletters",
  • "channels": [
    ]
}

Get Subscription Categories

Returns a list of all the subscription categories that are available in the system. This can be used to get the id of the subscription categories that are available in the system. This can be used as input when creating subscriptions for a member, as you need to reference the category_id along with the desired channel when creating a subscription.

SecurityOAuth2
Responses
200

A list of all the subscription categories that are available in the system.

400

The request could not be understood by the server due to malformed syntax.

401

The request has not been applied because it lacks valid authentication credentials for the target resource.

422

The request was well-formed but was unable to be followed due to semantic errors.

get/subscriptions/categories
Response samples
application/json
[
  • {
    }
]