Auth type: APIDocumentation Index
Fetch the complete documentation index at: https://hyperfx.ai/docs/llms.txt
Use this file to discover all available pages before exploring further.
For general setup steps, permissions, and troubleshooting, start with: App Integrations.
Connect Instantly
- Go to Settings → Apps in Hyper
- Select Instantly → Connect New
- Provide your Instantly API key
Common capabilities
- Automate cold email campaigns
- Personalize outreach at scale
- Track email delivery and engagement metrics
Use in Chat
Enable Instantly in the tool selector. Ask your agent to manage campaigns or check outreach performance.Use in Agents
Add Instantly to an agent’s toolkits and select the connection. Mark sensitive actions (send email) as “requires approval.”Use in Flows
Automate email sequences, follow-ups, and campaign management using Instantly action nodes.Troubleshooting
- API errors: verify your API key and account permissions
- Campaign issues: check campaign settings and sending limits
Available Actions
Hyper agents can run the following actions for this integration. Each action can be individually set to Enabled, Requires Approval, or Disabled in your agent’s toolkit settings. Actions can be set to one of three control states:| State | Behavior |
|---|---|
| Enabled | Agent runs the action automatically |
| Requires Approval | Agent pauses and waits for your confirmation before proceeding |
| Disabled | Action is blocked and cannot be used |
| Action | Description |
|---|---|
| Activate Campaign | Activate or resume a campaign |
| Add Leads To Campaign | Bulk add leads to a campaign (up to 1000). Provide campaign_id and leads: list of lead objects (each needs at least email for campaigns). Optional: skip_if_in_campaign, skip_if_in_workspace, verify_leads_on_import |
| Add Tags To Campaign | Assign or unassign custom tags on campaigns. resource_type 2 = campaign. Set assign True to add tags, False to remove |
| Create Campaign | Create a campaign. Body must match Instantly API V2 (e.g. name and sequence settings) |
| Create Custom Tag | Create a custom tag. Required: label; optional: description |
| Create Lead | Create a single lead. Body fields per API V2 (typically email; optional names, campaign_id, list_id) |
| Delete Campaign | Delete a campaign by ID |
| Delete Lead | Delete a lead by ID |
| Get Background Job | Get a background job by ID (import/export/move status) |
| Get Campaign | Get a single campaign by ID |
| Get Campaign Analytics | Get analytics for campaign(s). Query params may include id, ids, start_date, end_date (ISO dates) |
| Get Email | Get one email by ID |
| Get Lead | Get a lead by ID |
| Get Workspace | Get the current Instantly workspace for the API key |
| List Accounts | List sending email accounts |
| List Background Jobs | List background jobs with optional filters (limit, status, type, entity_id, etc.) |
| List Campaigns | List Instantly campaigns. Optional filters: limit (1-100), starting_after, search, tag_ids, etc. Pass query as JSON-encoded object if needed |
| List Completed Jobs | List background jobs; pass query e.g. status=success or failed to see completed work |
| List Custom Tags | List custom tags in the workspace |
| List Emails | List emails (Unibox). Optional query filters per API V2 |
| List Lead Lists | List lead lists in the workspace |
| List Leads | List leads via POST /leads/list. Pass filter body (pagination, campaign_id, search, etc.) per Instantly API V2 |
| List New Emails | List emails with optional query filters; use timestamps or campaign filters to narrow ‘new’ mail |
| List New Leads | List leads using the list endpoint; pass the same filter body you would use for instantly_list_leads (e.g. timestamp or campaign filters) |
| Patch Campaign | Patch an existing campaign by ID |
| Patch Lead | Patch a lead by ID |
| Pause Campaign | Pause a campaign |
| Reply To Email | Reply to an email. Body must include reply_to_uuid (the email to reply to) and content fields per API V2 |
| Unread Email Count | Get unread email count in Unibox |
| Update Lead Status | Update lead interest status for a lead email. new_status is the interest code: 0=Out of office, 1=Interested, 2=Meeting Booked, 3=Meeting Completed, 4=Won, -1=Not Interested, -2=Wrong Person, -3=Lost, -4=No Show. Provide campaign_id or list_id when scoping |
| Verify Email | Submit email(s) for verification per API V2 (body shape per /email-verification) |