Manage and retrieve the status of your Recipients using the API.
REST Methods
Note: API is case sensitive. Make all parameters entries lower case. All parameters in red are required.
Note: Write actions (POST, UPDATE, DELETE) may take several minutes to propagate and be reflected by the API. If a subsequent read request fails to reflect your changes, please wait a few minutes and try again.
| VERB | RESOURCE | PARAMETERS | DESCRIPTION |
| GET | /recipients/status |
|
Retrieves the status of the specified recipients. |
| POST | /recipients/activate |
|
Updates the status of the specified recipient(s) to active which, in turn, allows them to receive email. |
| – | |||
GET /recipients/statusRetrieves the status of the specified recipients. Valid values are active, meaning the recipient may be sent email, or inactive, meaning they have either bounced email or submitted a spam complaint. Parameters
Example Request curl --request GET "https://emailapi.dynect.net/rest/json/recipients/status?emailaddress=example@example.com&apikey=ABC123XYZ" Example Results (JSON) {"response":"status":200,"message":"OK","data":{"recipients:"[{"emailaddress":"email1@example.net","status":"inactive"},{"emailaddress":"email2@example.com","status",:"active"},{"emailaddress":"zoom3@example.com","status":"inactive"},…]}}
{"response":{"status":200,"message":"OK","data":{"recipients":[{"emailaddress":"email1@example.net","status":"active","suppressionstatus":"unsuppressed"},{"emailaddress":"bademail@nonexistent.com","status":"inactive","suppressionstatus":"pending removal"},{"emailaddress":"noonehere@nonexistent.com","status":"inactive","suppressionstatus":"suppressed"}]}}}
POST /recipients/activateUpdates the status of the specified recipient(s) to active which, in turn, allows them to receive email. Parameters
Example Request curl --request POST "https://emailapi.dynect.net/rest/json/recipients/activate" --data "apikey=ABC123XYZ&emailaddress=example@example.com" Example Results (JSON) {"response":{"status":200,"message":"OK","data":[]}}
|