This page describes the response returned by /MAILSUGGEST/, used to suggest email addresses.
Related Email documentation:
- Email introduction
- Email GET request
- Email POST request
- DQEEMAILLOOKUP response
- Email Swagger documentation
MAILSUGGEST response
Success response
The JSON response is a dictionary containing the suggest key. Its value is an array of suggested email addresses.
| Key | Description | Type |
|---|---|---|
| Instance | Instance number passed as a parameter during the request. | STRING(3) |
| syntaxe |
ok or ko. |
STRING(2) |
| suggest | List of suggested email addresses. | ARRAY |
Example:
{
"Instance": "0",
"suggest": [
"ttesta@",
"testat@",
"t.testa@",
"testbtesta@",
"ttestb@",
"testatestb@",
"testa.testb@",
"testb.testa@",
"testb-testa@",
"testa-testb@",
"t-testa@",
"testa-t@"
],
"syntaxe": "ok"
}
Error response
| Error type | Response type |
|---|---|
Missing Licence parameter |
400 Bad Request |
Empty Licence parameter |
400 Bad Request |
| Incorrect licence number | Empty response |
Related to