InboxRoad API Documentation

If you have questions regarding the API, please visit our API FAQ page.
To retrieve bounces and complaints there are two separate API views:

To retrieve hard bounces from InboxRoad please do the following:

Make a get request to https://api.inboxroad.com/api/v2/bounces with the correct bearer-token and content type as application/json

request GET

curl -H ‘Authorization: Token  {{ TOKEN }}’ -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.

response item

{
“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

last_id: [UUID of the last record]
Returns all logs from after the given record

order: [asc/desc]  Determines if you get the records in ascending or descending order

for example:

request GET

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

 

Pagination

All records are paginated with the following structure

 {
“count”: Total number of results,
“next”: URL to the next page of records,
“previous”: URL to the previous page of records,
“results”: [
…….,
list of results,
……
]
}

 

Would you also like to include soft bounces & expired bounces?

Do as above and add the following query parameter:

include_soft=1

Bounce type:

s: soft bounce
e: expired bounce
h: hard bounce

To retrieve complaints from InboxRoad please do the following:

Make a get request to https://api.inboxroad.com/api/v2/fbl with the correct bearer-token and content type as application/json

request GET

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

 

response

{
“uuid”: Unique identifier,
“timelogged”: Unix timestamp,
“header_list_unsubscribe”: List unsubscribe header,
“orig”: originator (from MAIL FROM:),
“rcpt”: recipient (RCPT TO:) being reported,
“header_subject”: Header subject line
“header_return_path”: Original ReturnPath,
“header_from”: Original Header from,
}

 

Query Parameters for complaints

last_id: [UUID of the last record]
Returns all logs from after the given record

for example:

request GET

 curl -H ‘Authorization: Bearer  {{ TOKEN }}’ -H ‘Content-Type:application/json’ https://api.inboxroad.com/api/v2/fbl?last_id=ce95fca7-b028-4f5c-810c-8bddeda4cac6

 

Pagination

All records are paginated with the following structure

 {
“count”: Total number of results,
“next”: URL to the next page of records,
“previous”: URL to the previous page of records,
“results”: [
…….,
list of results,
……
]
}