Newsman – Knowledge Base
Newsman Api Method: transactional.emailGetRejectStatus
Prototype: transactional.emailGetRejectStatus(list_id, email, account_id)
Description: Returns info about the reject status of an email. The response is a dict with the keys: unsub, hardbounce, spam, bounce. A message will be rejected if an email has a count of at least 1 for the status types spam, unsub, hardbounce. It will also be rejected if the status bounce (softbounce eg: out of storage space) exceeds 10.
HTTP method: GET
Endpoint HTTP: /transactional.emailGetRejectStatus.json
Endpoint XML-RPC: transactional.emailGetRejectStatus
Return type: arrayReturn info: Dict containing the following keys: unsub, hardbounce, spam, bounce
Request parameters GET
| Variable | Type | Description |
|---|---|---|
| list_id | int|string | The ID of the list from which to identify the SMTP account |
| string | The email for which to fetch the reject status info | |
| account_id | string|boolean | The id of a specific SMTP ACCOUNT from which to fetch the email reject status info (optional). |
Response parameters
| Parameter | Description |
|---|---|
| struct | dict containing the following keys: unsub, hardbounce, spam, bounce |
Output example
nullResponse Errors
| Code | Message | Description |
|---|---|---|
| 407 | Missing required param list_id | list_id param is required |
| 101 | Not allowed for list_id = %s | Invalid access to list_id |
| 17003 | Could not find the SMTP account | Transactional account not found |
| 17004 | The SMTP account is inactive | The transactional account is inactive |
| 17018 | The email reject status could not be fetched: [error_reason] | The email reject status could not be fetched |
Error examples
{ "err": true, "message": "Missing required param list_id", "code": 407 }
{ "err": true, "message": "Could not find the SMTP account", "code": 17003 }
{ "err": true, "message": "The SMTP account is inactive", "code": 17004 }
{ "err": true, "message": "The email reject status could not be fetched: [error_reason]", "code": 17018 }