Through the Email Newsletter Service's API, you can send newsletters, individual emails, manage recipient lists, view newsletter statistics, and more.
The basic URL for sending requests is:
Alternatively, if the main URL is blocked, you can use this URL:
Authentication is performed using a token, which must be included with each request. The token is sent with the Authorization header:
Authorization: Bearer **API_TOKEN**
Your API token is stored in your account and should not be shared with others.
Data is exchanged with the server in JSON format. Each request should include a Content-Type header:
Content-Type: application/json
Some requests allow you to retrieve data in collections. You can also retrieve data by page with a specific number of rows per page, specified in the pagenumber query parameter.
The page size, or the number of records per page, is specified in the pagesize parameter. For example, you can use the following command to get the second page with three records:
curl -X GET https://api.msndr.net/v1/email/lists?page_number=2&page_size=3 \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer $API_TOKEN'
If the requested page exceeds the maximum size, an error will be returned.
{
"errors": [
{
"code": 412,
"detail": "Page size is too big. Max value is 100"
}
]
}
The default page size is 100, but you can change it by specifying it in the request.
Here's an example response from the API:
{
"total_count":23,
"total_pages":8,
"page_number":2,
"page_size":3,
"collection":[
{
"id":1,
"title":"My Recipients"
},
{
"id":2,
"title":"My Recipients #2"
},
{
"id":3,
"title":"My Recipients #3"
}
]
}Where total_count is the total number of recipients, total_pages is the number of pages returned, page_number is the current page, page_size is the size of each page, and collection is an array containing the recipients.
Responses to queries may contain status codes. These codes can help you understand the status of your request.
Here are some common status codes and their meanings:
|
Code |
Description |
|
2xx |
The request is successfully completed |
|
400 |
Invalid parameters |
|
401 |
Authentication failed |
|
402 |
Insufficient funds |
|
404 |
Resource not found |
|
415 |
Unsupported data type |
|
422 |
Resource cannot be processed |
|
500 |
Unknown error |
