The QuickMail API is built upon GraphQL.

This guide is to help you get familiarised with its usage.

For convenience, we have a web app that you can use to test your integrations with your live data in QuickMail. Here’s where you can access it: https://api.quickmail.com/v2/graphiql

<aside> 💡

API rate limit is 10 requests per 10 seconds

</aside>

Authorization

To get started, paste this on the headers.

{
  "Authorization": "<API_KEY>"
}

Then, generate your API in QuickMail and replace the word <API_KEY> with it.

Here’s an article to help you generate an API key.

Next, click the play button. If the API key is valid, it should show the name of your agency, as well as the ID. Like this:

• Common error/s when setting up authorization

Documentation