Mail status
Check the status of emails sent
GET /mailer/mail_status
This endpoint retrieves the status of mail sent through the applet.
Request
-
Method: GET
-
URL:
https://applet.payherokenya.com/mailer/mail_status
-
Query Parameters:
-
batch_id (string, required) - The ID of the batch for which the mail status is to be retrieved.
-
api_username (string, required) - The username for API authentication.
-
page (integer, required) - The page number for paginated results.
-
per_page (integer, required) - The number of records to be displayed per page.
-
Response
The response is in JSON format and follows the schema below:
{
"data": [
{
"batch_id": "string",
"recipient_email": "string",
"subject": "string",
"status": 0,
"description": "string",
"updated_at": "string"
}
],
"pagination": {
"current_page": "string",
"per_page": "string",
"total_records": 0,
"total_pages": 0
}
}
The data
array contains information about the mail status, including batch ID, recipient email, subject, status code, description, and update timestamp. The pagination
object provides details about the current page, records per page, total records, and total pages.
67d81cfdacc
jeBrLJ4AIRP2AGbOt
1
100
GET /mailer/mail_status HTTP/1.1
Host: applet.payherokenya.com
Authorization: noauth YOUR_SECRET_TOKEN
Accept: */*
OK
{
"data": [
{
"batch_id": "67d81c2dacc",
"recipient_email": "[email protected]",
"subject": "Survival is winning",
"status": 1,
"description": "Email successfully sent to: [email protected]",
"updated_at": "2025-03-17 13:01:04"
}
],
"pagination": {
"current_page": "1",
"per_page": "100",
"total_records": 1,
"total_pages": 1
}
}
Was this helpful?