Introduction

This documentation is for the second version of the Instantly API.

Looking for the documentation of the first version of the API (now deprecated)? Click here.

What's new

The second version with the API comes with a lot of improvements:

1. API Scopes offer enhanced security and control over the API keys and how they're being used.
2. Double the amount of endpoints as compared to V1.
3. Strict adherence to REST API Standards.
4. Follows strict naming rules for entities, fields (snake_case), etc.

V1 compatibility

• The first version of the API will still be available and maintained for a while, but we plan to deprecate it in 2025, so please migrate to API V2 as soon as possible.
• The second version of the API has NO compatibility with the first version of the API. You will need a new API key to use the API V2 endpoints.

Authentication

We are using Bearer token authentication, which is more secure than the previous version authentication.

Multiple API keys

It's possible to create multiple API keys, which can be revoked, improving the security.

API scopes

We're introducing API scopes, which can be used to offer granular control for each API key.

REST endpoints

The second version of the API is adhering to the REST API standards, with a few minor exceptions.