- Overview
- Authentication
- Libraries
- Methods
- Contacts
- Import file
- Bulk Import
- Contact import current status
- Contact import history
- Subscriptions
- Attributes
- Lists
- Subscribers
- Subscription forms
- Mails
- Drafts
- Send
- Sent
- Scheduled
- Auto-responder mails
- Templates
- HTML
- Block
- Auto-responders
- Profile
- Address
- Senders
- Reports
- Bounces
- Clicks
- Links
- Opens
- Opens aggregated
- Have not opened
- Most active customers
- Unsubscriptions
- Invoices
- Notifications
Bounces
The bounces object gives you the ability to GET information about bounces for specific reports.
Renders: [application/json, text/html, application/xml]
Parsers: [application/json, application/x-www-form-urlencoded, multipart/form-data]
Readonly fields
status
contact
description
contact_active
url
created
contact_url
error_type
Example bounce
{
"url": "https://api.getanewsletter.com/v3/reports/123/bounces/543/",
"status": "4.2.2",
"contact": "john.doe@example.com",
"contact_url": "https://api.getanewsletter.com/v3/contacts/john.doe@example.com/",
"contact_active": true,
"description": "Mailbox full",
"created": "2013-08-27T13:33:11.462Z"
"error_type": "Soft bounce."
}
GET /reports/<report_id>/bounces/
Responds with a list of attributes, like usual we provide next
, prev
, count
and the results
.
Possible url parameters are:
- page:
<int>
Example:
GET /reports/123/bounces/
{
"count": 46,
"next": "https://api.getanewsletter.com/v3/reports/123/bounces/?page=3",
"previous": "https://api.getanewsletter.com/v3/reports/123/bounces/?page=2",
"results": [
{
"url": "https://api.getanewsletter.com/v3/reports/123/bounces/543/",
"status": "4.2.2",
"contact": "john.doe@example.com",
"contact_url": "https://api.getanewsletter.com/v3/contacts/john.doe@example.com/",
"contact_active": true,
"description": "Mailbox full",
"created": "2013-08-27T13:33:11.462Z",
"error_type": "Soft bounce."
},
...
]
}
GET /reports/<report_id>/bounces/<id>/
Responds with a report.
Example:
GET '/reports/123/bounces/543/
{
"url": "https://api.getanewsletter.com/v3/reports/123/bounces/543/",
"status": "4.2.2",
"contact": "john.doe@example.com",
"contact_url": "https://api.getanewsletter.com/v3/contacts/john.doe@example.com/",
"contact_active": true,
"description": "Mailbox full",
"created": "2013-08-27T13:33:11.462Z",
"error_type": "Soft bounce."
}
Exporting bounces
GET /reports/<report_id>/bounces/export/
Possible url parameters are:
- csv:
<0|1>
If the csv
parameter is not provided the API automatically returns xls-file for all exports under 64 000 rows, and with csv-file for bigger.
The export includes the bounced email and the type of the bounce.