Docs
Open Lodol
DocumentationIntegrationsAPI

Instantly

App · Email Marketing · 8 actions

Automate cold email outreach with Instantly: manage campaigns, leads, sending accounts, and analytics.

Actions

ActionWhat it does
Activate campaignActivate (start sending) an Instantly campaign by ID.
Create campaignCreate a new cold email campaign with a default sending schedule.
Create leadAdd a lead to an Instantly campaign or lead list.
Get campaignRetrieve details for a single Instantly campaign by ID.
Get campaign analyticsRetrieve analytics for one or all campaigns over an optional date range.
List campaignsList cold email campaigns in your Instantly workspace.
List leadsList or search leads, optionally filtered by campaign.
List sending accountsList the email sending accounts connected to Instantly.

Activate campaign

Activate (start sending) an Instantly campaign by ID.

Inputs

Campaign IDcampaign_idtextRequired
Campaign ID to activate.

Outputs

Response envelope; the payload is in the "result" field.

resultobject
Example output
{
  "result": {
    "id": "01890000-0000-7000-a000-000000000001",
    "status": 1
  }
}

Create campaign

Create a new cold email campaign with a default sending schedule.

Inputs

NamenametextRequired
A name for the new campaign.
Daily start timetiming_fromtime
Time of day to start sending each day, in 24-hour HH:MM format. Defaults to 09:00.Default: 09:00.
Daily end timetiming_totime
Time of day to stop sending each day, in 24-hour HH:MM format. Defaults to 17:00.Default: 17:00.
Time zonetimezonetext
Time zone the daily sending times are based on. Defaults to US Eastern time.One of: America/Detroit (US Eastern (Detroit)), America/Chicago (US Central (Chicago)), America/Boise (US Mountain (Boise)), America/Creston (US Mountain, no DST (Creston)), America/Dawson (US Pacific (Dawson)), America/Anchorage (US Alaska (Anchorage)), Europe/Isle_of_Man (UK (Isle of Man)), Europe/Belgrade (Central Europe (Belgrade)), Asia/Kolkata (India (Kolkata)), Australia/Melbourne (Australia (Melbourne)). Default: America/Detroit.
Sending daysdayslist
Days of the week to send on, as numbers from 0 (Sunday) to 6 (Saturday). Defaults to Monday–Friday.Default: [1, 2, 3, 4, 5].

Outputs

Response envelope; the payload is in the "result" field.

resultobject
Example output
{
  "result": {
    "id": "01890000-0000-7000-a000-000000000001",
    "name": "Q1 Outbound",
    "status": 0
  }
}

Create lead

Add a lead to an Instantly campaign or lead list.

Inputs

Emailemailtext
Lead email address. Required when adding to a campaign; optional when adding to a lead list as long as a first or last name is provided.
Campaign IDcampaign_idtext
ID of the campaign to add the lead to.
List IDlist_idtext
ID of the lead list to add the lead to.
First namefirst_nametext
Lead first name.
Last namelast_nametext
Lead last name.
Company namecompany_nametext
Lead company name.
Phonephonetext
Lead phone number.
Websitewebsitetext
Lead website URL.
Personalizationpersonalizationtext
Personalization snippet used in the first email.
Custom variablescustom_variablesobject
Extra fields to save on the lead, as name and value pairs. Each value can be text, a number, true/false, or empty (no nested lists or groups).

Outputs

Response envelope; the payload is in the "result" field.

resultobject
Example output
{
  "result": {
    "campaign": "01890000-0000-7000-a000-000000000001",
    "email": "jane@example.com",
    "id": "01890000-0000-7000-b000-000000000001"
  }
}

Get campaign

Retrieve details for a single Instantly campaign by ID.

Inputs

Campaign IDcampaign_idtextRequired
Campaign ID.

Outputs

Response envelope; the payload is in the "result" field.

resultobject
Example output
{
  "result": {
    "id": "01890000-0000-7000-a000-000000000001",
    "name": "Q1 Outbound",
    "status": 1
  }
}

Get campaign analytics

Retrieve analytics for one or all campaigns over an optional date range.

Inputs

Campaign IDcampaign_idtext
Campaign ID to get analytics for. Leave empty to include all campaigns.
Start datestart_datetext
Start date (YYYY-MM-DD).
End dateend_datetext
End date (YYYY-MM-DD).

Outputs

resultlist
Per-campaign analytics rows.
Example output
{
  "result": [
    {
      "campaign_id": "01890000-0000-7000-a000-000000000001",
      "emails_sent_count": 480,
      "leads_count": 500,
      "open_count": 240,
      "reply_count": 32
    }
  ]
}

List campaigns

List cold email campaigns in your Instantly workspace.

Inputs

Limitlimitnumber
Maximum number of campaigns to return.
Searchsearchtext
Filter campaigns by name.
Statusstatusnumber
Only show campaigns in this state.One of: 1 (Active), 2 (Paused), 3 (Completed), 0 (Draft).
Starting afterstarting_aftertext
Pagination cursor from a previous response's next_starting_after value; returns the next page.

Outputs

Response envelope; the payload is in the "result" field.

resultobject
Example output
{
  "result": {
    "items": [
      {
        "id": "01890000-0000-7000-a000-000000000001",
        "name": "Q1 Outbound",
        "status": 1
      }
    ],
    "next_starting_after": null
  }
}

List leads

List or search leads, optionally filtered by campaign.

Inputs

Campaign IDcampaign_idtext
Only show leads in this campaign.
Limitlimitnumber
Maximum number of leads to return.
Searchsearchtext
Search leads by email, name, or company.
Starting afterstarting_aftertext
Pagination cursor from a previous response's next_starting_after value; returns the next page.

Outputs

Response envelope; the payload is in the "result" field.

resultobject
Example output
{
  "result": {
    "items": [
      {
        "email": "jane@example.com",
        "id": "01890000-0000-7000-b000-000000000001"
      }
    ],
    "next_starting_after": null
  }
}

List sending accounts

List the email sending accounts connected to Instantly.

Inputs

Limitlimitnumber
Maximum number of accounts to return.
Searchsearchtext
Filter accounts by email address.
Starting afterstarting_aftertext
Pagination cursor from a previous response's next_starting_after value; returns the next page.

Outputs

Response envelope; the payload is in the "result" field.

resultobject
Example output
{
  "result": {
    "items": [
      {
        "email": "outreach@example.com",
        "status": 1
      }
    ],
    "next_starting_after": null
  }
}

Instagram for Business

Previous Page

Instapaper

Next Page

On this page

ActionsActivate campaignCreate campaignCreate leadGet campaignGet campaign analyticsList campaignsList leadsList sending accounts