List Reason Codes

get

{protocol}://{server}{basePath}/accounts/{accountId}/communication-managers/{communicationManagerId}/reason-codes

This API requires the Account Administrator role.

Returns list of Reason Codes based on the specified filtering criteria. If no filtering criteria is specified, this call returns list of all Reason Codes.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

length between 6 and 6

^[a-zA-Z]{6}$

The unique 6 character internal id that represents the customer account.

communicationManagerId

uuid

required

The unique id of the Communication Manager

Query Params

codeType

string

enum

required

The mandatory type of the codes to query.

Allowed:

codeName

string

length between 1 and 255

The optional name of the code to query.

codeNumber

string

length between 1 and 16

The optional number of the code to query.

pageNumber

int32

≥ 1

Defaults to 1

The page number of the records to retrieve. Default value is 1.

pageSize

int32

1 to 100

Defaults to 10

The maximum number of results per page. Default value is 10, max value is 100.

orderBy

string

length ≤ 260

Defaults to codeName

Specifies how response data should be sorted. Only codeName and codeNumber are valid options.
Field Names are case-senstive (should be written as it is in description).
To specify descending order, a suffix " desc" should be added. For example, "codeName asc" for ascending or "codeName desc" for descending".
The default sorting order is codeName ascending.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses