API configuration: instantly


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

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 in Nango 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 on the corresponding Instantly docs pages.
  • After creating a connection, you can use the api_key as follows;
    const connection = await nango.getConnection();

    let api_key: string;
    if ('apiKey' in connection.credentials) {
        api_key = connection.credentials.apiKey;
    } else {
        throw new nango.ActionError({
            message: `API key credentials is incomplete`

    const postData = {
        api_key: api_key,
        campaign_id: input.campaign_id,
        name: input.name

    const resp = await nango.post({
        endpoint: `/v1/campaign/set/name`,
        data: postData