ListDomainIdentities method
Returns a list of addresses in a folder. The folder is selected based on the service account the request originates from.
Request
GET /v2/email/identities HTTP/2
Query parameters
|
Parameter |
Description |
|
|
Type: Integer. Maximum number of results you can get on one page in response to your request. If the number of results exceeds the The maximum permissible value for the parameter is |
|
|
Type: String. Token to get the next results page in response to a request. To do this, provide the The maximum string length for the parameter is 100 characters. |
Request headers
Use common request headers in your requests.
Responses
200 OK
{
"EmailIdentities": [
{
"IdentityType": "<address_type>",
"IdentityName": "<address>",
"SendingEnabled": <address_state>,
"VerificationStatus": "<verification_status>"
}
],
"NextToken": "<token>"
}
|
Parameter |
Description |
|
|
Type: Array. Array of addresses. |
|
|
Type: String. Type of address. Possible value: |
|
|
Type: String. Address. |
|
|
Type: Boolean. Indicates whether you can send emails from this address. Possible values: Before sending emails from this address, you must pass a verification as its owner. |
|
|
Type: String. Verification status:
|
|
|
Type: String. Token to get the next results page in response to a request. If the number of results exceeds the |
The 200 OK response may contain additional parameters. Its format may vary slightly from the above.
Errors
For all errors, the response body has the same format:
{
"Code": "<error_name>",
"message": "<error_description>"
}
The name of the error is taken from its code, e.g., BadRequestException.
Possible errors:
|
Error code |
Description |
|
|
The request contains invalid headers or parameters. |
|
|
The request quota was exceeded. |