| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://api.kickofflabs.com/ | link | — | — | — |
Actions (24)
Leads · 15
- Add lead to waitlistPOST /v2/{campaign_id}/waitlist
Put a lead back on the leaderboard/waitlist that had been removed before.
documented - Add points to leadPOST /v2/{campaign_id}/points
Assign custom points to a lead or group of leads.
documented - Approve leadPOST /v2/{campaign_id}/approve
Manually override a lead that has been flagged as fraudulent.
documented - Block leadPOST /v2/{campaign_id}/block
Manually flag a lead as fraudulent.
documented - Complete campaign actionPOST /v2/{campaign_id}/actions/{campaign_action_id}
Marks a campaign action as complete for a lead.
documented - Complete parent actionPOST /v2/{campaign_id}/actions/{campaign_action_id}/parent
Marks a campaign action as complete by the parent lead.
documented - Create or update leadPOST /v2/{campaign_id}
Adds a new lead or modifies an existing lead on your campaign.
documented - Delete leadDELETE /v2/{campaign_id}
Remove one or more leads from your campaign.
documented - Email opt-outPOST /v2/{campaign_id}/optout
Removes one or more leads from being emailed by the campaign.
documented - Get lead detailsGET /v2/{campaign_id}
Get the lead information for a lead on your campaign.
documented - Lead infoGET /v1/{campaign_id}/info
Retrieve information about an existing subscriber.
documented - Remove from waitlistPOST /v2/{campaign_id}/unwaitlist
Removes one or more leads from the waitlist or leaderboard without deleting them.
documented - Subscribe leadPOST /v1/{campaign_id}/subscribe
Add a lead to your campaign.
documented - Verify leadPOST /v2/{campaign_id}/verify
Verify one or more leads in your contest.
documented - Verify lead phone numberPOST /v2/{campaign_id}/verify-phone-number
Verify a lead’s phone number with a confirmation code (Twilio integration).
documented
Campaigns · 5
- Get campaign statsGET /v2/{campaign_id}/stats
Fetches overview statistics for the campaign.
documented - List campaign actionsGET /v2/{campaign_id}/actions
Fetches actions configured for the given campaign.
documented - List campaign lead tagsGET /v2/{campaign_id}/lead-tags
Fetches lead tags defined for the campaign.
documented - List campaign leaderboard (v1)GET /v1/{campaign_id}/leaderboard
Retrieves the campaign leaderboard using the legacy v1 endpoint.
documented - List leaderboard (v1)GET /v1/{campaign_id}/leaderboard
Fetch the leaderboard for a campaign (legacy endpoint).
documented
Lead Tags · 4
- Bulk tag leadsPOST /v2/{campaign_id}/tags
Applies the supplied tag id to one or more leads.
documented - KOL.js taggingPOST /v2/{campaign_id}/tags
Tagging via KOL.js (Coming soon).
documented - Tag leadPOST /v2/{campaign_id}/tags/{tag_id}/lead
Tags (and creates) a lead with the given lead tag.
documented - Tag lead parentPOST /v2/{campaign_id}/tags/{tag_id}/referral
Tags the parent (if one exists) of a lead.
documented