Integration · API
An API that turns one HTTP call into an AI call campaign
Post a contact with a tag and the campaign starts: text, wait, AI call, calendar booking, retries. Read back every run, outcome and transcript. Keys are scoped to an organization, upserts are idempotent, and there is nothing else to wire.
- Org-scoped API keys
- Idempotent upsert on phone or email
- Runs, outcomes and transcripts readable
API
Bearer API key
- Scope
- Organization
- Triggers
- Contact created · Tag added · Added to list
What it does
Where API shows up in a campaign
Three places an integration can appear: as the event that starts a run, as a node in the workflow, or as a tool the agent calls mid-conversation.
Triggers
Contact created · Tag added · Added to list
Creating or upserting a contact through the API emits the same internal events as the app. Any published workflow whose trigger matches starts a run for that contact.
Workflow nodes
Agent tools
The agent does not call API tools directly; API is used by the workflow nodes.
Campaigns
Three campaigns teams run with API
Each one is a published workflow you can draw in an afternoon. The guides walk through every node.
Speed to lead
Your form handler or CRM makes one call; the lead is phoned within a minute.
- POST /contacts/upsert
- Contact created
- Send SMS
- AI call
- Loop ×3
Database reactivation
Import a list with a tag through the API and the campaign works through it inside quiet hours.
- POST /contacts/import
- Tag added
- Send SMS
- AI call
Callback handling
Your phone system tags a missed caller through the API; the agent calls back and books.
- POST /contacts/upsert · tag
- AI call
- Loop counter
- Send SMS
Setup
First call in ten minutes
One key, one endpoint, one published workflow.
- 1
Create a key
On the API keys page, create a key for the organization. It is shown once, at creation, and can be renamed or revoked later.
- 2
Publish a workflow on a tag
Draw a campaign that starts from Tag added, for example api-new-lead, and publish it.
- 3
Upsert a contact
POST to the contacts upsert endpoint with a Bearer header, matchBy phone, the contact's fields, and tags containing that tag. Use your own number the first time.
- 4
Watch the run
The response includes the contact. The run appears on the runs endpoint and the logs page within seconds, with each step, the call outcome and the transcript.
- 5
Read outcomes back
Poll the contact's activity or the workflow runs endpoint to pull outcomes into your CRM.
Details
What the API supports today
Endpoints, semantics and limits, so you can plan an integration without surprises.
- Authentication
- Authorization: Bearer with an organization API key. Keys are hashed at rest; the organization is implied by the key, so no extra header is needed.
- Contacts
- Create, upsert, bulk import, list, get, update, delete, plus add and remove tags and lists. Upsert matches on phone or email, merges tags and adds lists; update replaces both.
- Workflows and runs
- List and get workflows; start a manual run for a contact; list runs, get a run, its steps and its timeline; cancel a run.
- Logs and activity
- An organization-wide communications log filterable by channel, status and contact, and a per-contact activity feed with outcomes and transcripts.
- Inbound webhooks
- None generic today. Provider webhooks exist for Calendly and Vapi. To start a campaign from another system, upsert the contact; it is one HTTP call and starts the workflow the same way.
- Outbound webhooks
- None today. SuperCampaign does not call your endpoint when a call ends; poll runs or contact activity instead.
- Responses and errors
- JSON envelopes with success, data and meta; errors carry a code and message. Duplicate-contact conflicts return 409.
- Rate limits
- 1,000 requests per 15 minutes per IP. Bulk import accepts thousands of rows in one request.
FAQ
Questions about the API integration
Is there a webhook I can post leads to?
Not a generic inbound webhook today. Post to the contacts upsert endpoint instead: it is one HTTP call with a Bearer key, and it starts the campaign through the contact-created or tag-added event exactly as a webhook would. Calendly and Vapi have dedicated provider webhooks.
Can SuperCampaign call my system when a call finishes?
Not today. Read outcomes by polling the workflow runs endpoint or the contact's activity feed, both of which include the outcome and transcript within seconds of the call ending.
How do I avoid duplicate contacts?
Use the upsert endpoint with matchBy set to phone or email. The first match wins, tags are merged and lists are added, so re-sending a lead updates rather than duplicates.
Can I trigger a specific workflow rather than rely on a tag?
Yes. The workflows run endpoint starts a manual run of a given workflow for a given contact. Tags are the usual way because they let several workflows react to one event.
Does the API work with Zapier, Make or n8n?
Yes. Each has an HTTP request action; point it at the upsert endpoint with your key. There is no native app for any of them today.
Where do I find the endpoint URL?
On the API keys page in the app, alongside the key you create. The base URL depends on your deployment.
Hear it before you believe it.
Drop your number and our agent will call you in about 30 seconds. Or create a free account and publish your first workflow today.