Instantly

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

Activate campaign

Activate (start sending) an Instantly campaign by ID.

Parameters

Parameter	Type	Required	Description
`campaign_id`	string	Yes	Campaign ID to activate.

Response

{
  "id": "01890000-0000-7000-a000-000000000001",
  "status": 1
}

Create campaign

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

Parameters

Parameter	Type	Required	Description
`name`	string	Yes	A name for the new campaign.
`timing_from`	string	No	Time of day to start sending each day, in 24-hour HH:MM format. Defaults to 09:00.
`timing_to`	string	No	Time of day to stop sending each day, in 24-hour HH:MM format. Defaults to 17:00.
`timezone`	string	No	Time zone the daily sending times are based on. Defaults to US Eastern time.
`days`	array	No	Days of the week to send on, as numbers from 0 (Sunday) to 6 (Saturday). Defaults to Monday–Friday.

Response

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

Create lead

Add a lead to an Instantly campaign or lead list.

Parameters

Parameter	Type	Required	Description
`email`	string	Yes	Lead email address.
`campaign_id`	string	No	ID of the campaign to add the lead to.
`list_id`	string	No	ID of the lead list to add the lead to.
`first_name`	string	No	Lead first name.
`last_name`	string	No	Lead last name.
`company_name`	string	No	Lead company name.
`phone`	string	No	Lead phone number.
`website`	string	No	Lead website URL.
`personalization`	string	No	Personalization snippet used in the first email.
`custom_variables`	object	No	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).

Response

{
  "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.

Parameters

Parameter	Type	Required	Description
`campaign_id`	string	Yes	Campaign ID.

Response

{
  "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.

Parameters

Parameter	Type	Required	Description
`campaign_id`	string	No	Campaign ID to get analytics for. Leave empty to include all campaigns.
`start_date`	string	No	Start date (YYYY-MM-DD).
`end_date`	string	No	End date (YYYY-MM-DD).

Response

{
  "result": [
    {
      "campaign_id": "01890000-0000-7000-a000-000000000001",
      "emails_sent_count": 480,
      "leads_count": 500,
      "open_count": 240,
      "reply_count": 32
    }
  ]
}

List sending accounts

List the email sending accounts connected to Instantly.

Parameters

Parameter	Type	Required	Description
`limit`	number	No	Maximum number of accounts to return.
`search`	string	No	Filter accounts by email address.

Response

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

List campaigns

List cold email campaigns in your Instantly workspace.

Parameters

Parameter	Type	Required	Description
`limit`	number	No	Maximum number of campaigns to return.
`search`	string	No	Filter campaigns by name.
`status`	number	No	Only show campaigns in this state.

Response

{
  "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.

Parameters

Parameter	Type	Required	Description
`campaign_id`	string	No	Only show leads in this campaign.
`limit`	number	No	Maximum number of leads to return.
`search`	string	No	Search leads by email, name, or company.

Response

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

Instantly

On this page