Instantly

API configuration: instantly

Features

Features	Status
Auth (API Key)	✅
Sync data	✅
Perform workflows	✅
Proxy requests	✅
Receive webhooks	🚫 (time to contribute: <48h)

We can implement missing features in <48h, just ask for it in the community.

Getting started

• Generate an API key

• API docs

Need help getting started? Get help in the community.

API gotchas

• You need to be on the Hypergrowth plan (or above) to be able to access the API key.

• Instantly uses the API_KEY authentication mode to access different endpoints. The api_key is used differently depending on the endpoint. For GET, PATCH, and DELETE requests, it is appended to the query parameters, while for some POST requests, it is included in the request body. To clarify this, please check the corresponding Instantly docs pages.

• After creating a connection, you can use the api_key as follows:

  const connection = await terapi.getConnection();
  
  let api_key: string;
  if ('apiKey' in connection.credentials)  else );
  }
  
  const postData = ;
  
  const resp = await terapi.post();

• You can have a look at the following simple action template based on the Instantly Set campaign name action.

• Instantly enforces a general rate limit of 10 requests per second. For more details, check Instantly rate limits.

Add Getting Started links and Gotchas by editing this page