Bounces API Documentation

Welcome to our Bounces API documentation. If you need more information about this API, we recommend that you visit our API FAQ page. Our API is designed to allow you to easily send and receive emails, and we are constantly working to improve and update our services to better meet the needs of our users. Whether you are a developer looking to integrate email functionality into your application or a business looking to streamline your email communications, our API can help you achieve your goals.

Bounces occur when an email is returned to the sender because it cannot be delivered to the recipient. This API allows you to retrieve and analyze these bounce events to better understand why emails are not being delivered.

Retrieving Hard Bounces

To retrieve hard bounces from Inboxroad, make a GET request to https://api.inboxroad.com/api/v2/bounces with the correct Bearer-Token and Content-Type: application/JSON.

curl -H ‘Authorization: Token  {{ TOKEN }}’
curl -H ‘Content-Type:application/json’ https://api.inboxroad.com/api/v2/bounces

* You have received your API token during your set-up at inboxroad. If not, please contact your account manager.

{
     'uuid”: Unique identifier,
     “timelogged”: Unix timestamp,
     “bounce_type”:  ‘s’ for soft,
                         ‘h’ for hard,
                         ‘e’ for message expired,
     “rcpt”: recipient (RCPT TO: ) being reported,
     “orig”: originator (from MAIL FROM: ),
     “dsndiag”: DSN diagnostic string for the recipient to which it refers,
     “bouncecat”: likely category of the bounce,
     “header_from”: from header (of original email, complaints),
 }

Fields in JSON response

The response will be in JSON format and will include the following fields:

  • uuid: Unique identifier
  • timelogged: Unix timestamp
  • bounce_type: ‘s’ for soft, ‘h’ for hard, ‘e’ for message expired
  • rcpt: Recipient (RCPT TO:) being reported
  • orig: Originator (from MAIL FROM:)
  • dsndiag: DSN diagnostic string for the recipient to which it refers
  • bouncecat: Likely category of the bounce
  • header_from: From header (of original email, complaints)

Query parameters for bounce calls

The following query parameters can be used for bounce calls:

  • last_id: [UUID of the last record] – Returns all logs after the given record.
  • order: [asc/desc] – Determines whether records are returned in ascending or descending order.

For example:

Get request
curl -H ‘Authorization: Token  {{ TOKEN }}’
curl -H ‘Content-Type:application/json’ https://api.inboxroad.com/api/v/bounces?last_id=ce95fca7-b028-4f5c-810c-8bddeda4cac6&order=asc

Understand email delivery issues easily

The Bounces API is an essential tool for any user looking to better understand why emails are not being delivered. With the ability to retrieve and analyze hard bounces, you can easily troubleshoot any issues and ensure your emails are being sent out without any issues. If you need more information or have any questions about our API, please don’t hesitate to contact our support team.