API FAQ

The InboxRoad API enables costumers to programmatically access accounting data such as bounces and complaints. With this Frequently Asked Questions page we try guide you through the process of setting this up.

How…

do I find my API token?

You can find your API token in the documentation provided by your account manager. If you can’t find this information anymore, contact us at contact@inboxroad.com or click here.

do I test if the API works?

We do have some mock-up data available. Here is some preview data for bounces & complaints. With this you can run a test to see if your system can work with the data.

long is the accounting data stored?

We store the data for 30 days.

can I only collect new records?

You can collect only the new data if you add a ‘?last_id=last uuid’ from the latest record you have collected.
Our response is ordered by newest first, so the latest record known to us is the first result. Use this uuid for your next request.

often is the data updated?

We update the data on a daily basis. 

do I add custom headers to the responses?

Yes this is possible. Let your account manager know exactly what the header needs to be. For example: “X_customheader”

do I also receive the soft bounces and the expired messages?

If you setup the API you will receive the hard bounces.
Add the following query parameter to also receive the soft and expired bounces:

include_soft=1

Bounce type:

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

What…

should I do with the feedback I receive?

We do not process the bounces/ complaints. We provide you with this information and you should process this yourself.

We recommend to permanently suppress the complaints.
For the bounces we recommend the following:

h: hard bounce; suppress these permanently
s: soft bounce; you could suppress the soft bounces for a short period
e: expired message; no action required
o: other; no action required

do these bounce codes mean?

In the API call you receive the bounce feedback. To know what these bounce codes mean, please visit the postmaster page of the domain.

For general information about bounce codes you can check https://betterbounces.net/email-error

are the costs of the InboxRoad API?

The use of the API is free to all InboxRoad customers, regardless the tier you are in.

kind of data can I get through the API?

Hard-, soft bounces, expired messages and complaints.

Why…

do I need to setup the API?

With the feedback you receive in the API you can process hard bounces and complaints. This will lead to a healthier email list and to an overall better deliverability.

do I not see any data when running the API?

Make sure you use the correct token.

The first bounces and complaints are visible after 24 hours. If you don’t see bounces and complaints yet, it could be that there are none on your campaign. Try sending a test email to a sample hard bounce and check again after 24 hours.

If this doesn’t work, don’t hesitate to contact us.

do I not see any complaints in the output?

We have separate API calls for bounces and complaints. Please make sure you are using both.

Bounces & complaints.

do I see multiple bounces/complaints with the same email address?

Sometimes it takes some time before bounces are processed. If it takes a couple of days to process and the same email list is used on a daily base, it is possible that you see the same bounce address multiple times.

It is also possible that people complain on emails from the past. If people complain on emails from the past it could happen that you see the same email address multiple times in the complaint logs.