GET /messaging/v1/email/definitions

Gets a list of send definitions.

URL Parameters

NameTypeDescription
$filterstringFilter by status type. Accepted values are active, inactive, or deleted. Valid operations are eq and neq.
$pageSizeintegerNumber of definitions, which are array elements, to return per paged response.
$pageintegerPage number to return.
$orderBystringSort by a dimension. You can sort by only one dimension. Accepted values are definitionKey, name, createdDate, modifiedDate, and status.
StatusNameTypeDescription
200  Success
 requestIdstringThe unique identifier of this request.
 namestringName of the definition.
 definitionKeystringUnique, user-generated key to access the definition object.
 statusstringOperational state of the definition: active, inactive, or deleted. A message sent to an active definition is processed and delivered. A message sent to an inactive definition isn’t processed or delivered. Instead, the message is queued for later processing for up to three days.
 createdDatestringDate the definition was created.
 modifiedDatestringDate and time the definition was most recently changed.

Example Request

Example Response

HTTP Responses

ResponseReason
200 OKSuccess. Review example response.
400 Bad RequestInvalid request
403 ForbiddenFailed to pass authorization.
500 Server ErrorInternal error