List all use case types

Returns a list of all possible use case types for campaigns

get/messaging-brands/enum/usecase

Request

Base URL: https://api.fonestorm.com/v2
URL: https://api.fonestorm.com/v2/messaging-brands/enum/usecase
Auth: API key in header token

Query parameters

valid_sub_usecaseboolean

Filter by sub-usecase validity

Response

Success

object required

Keyed by use case code.

Example response

{
  "2FA": {
    "classification": "STANDARD",
    "description": "Two-Factor authentication, one-time use password, password reset",
    "displayName": "2FA",
    "maxSubUsecases": 0,
    "minSubUsecases": 0,
    "validSubUsecase": true
  },
  "ACCOUNT_NOTIFICATION": {
    "classification": "STANDARD",
    "description": "All reminders, alerts, and notifications.  (Examples include:  flight delayed, hotel booked, appointment reminders.)",
    "displayName": "Account Notification",
    "maxSubUsecases": 0,
    "minSubUsecases": 0,
    "validSubUsecase": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.