/command_types

Use this resource to view the list of possible command types.

Secured By: Authentication Token
Description:

List of command types that can be used with a keyword.

Refer to description of params parameter in the POST method of the /keywords/{id}/commands endpoint.

Headers

Name Required Type Description
X-AUTH-TOKEN * string

An authentication token provided to you by GovDelivery.

Status

Body

Format: application/json

Example
[
  {
    "name": "dcm_unsubscribe",
    "string_fields": [],
    "array_fields": [
      "dcm_account_codes"
    ]
  },
  {
    "name": "dcm_subscribe",
    "string_fields": [
      "dcm_account_code"
    ],
    "array_fields": [
      "dcm_topic_codes"
    ]
  },
  {
    "name": "forward",
    "string_fields": [
      "http_method",
      "username",
      "password",
      "url",
      "from_param_name",
      "sms_body_param_name",
      "strip_keyword"
    ],
    "array_fields": []
  }
]

Body

Format: application/json

Example
{
  "error": "Invalid authentication token"
}