Success.ai API
Dashboard

Changelog

Track every addition, change, deprecation, and fix across all versions of the Success.ai API.

v1/v2 Latest June 23, 2026

Lead and company search endpoints now support configurable response data options with option-specific credit handling. View v1/v2 API Reference →

⟳ Changed
  • POST /v1/mixed_people/search now supports dataOptions for work email reveal, full contact and company, and mobile phone reveal credit handling; omitted people dataOptions default to workEmailReveal
  • POST /v2/mixed_people/search now supports dataOptions for work email reveal, full contact and company, and mobile phone reveal credit handling; omitted people dataOptions default to workEmailReveal
  • POST /v1/company/find now requires exactly one company dataOptions value: basic or full
  • POST /v2/company/find now requires exactly one company dataOptions value: basic or full
v2 Stable May 15, 2026

Major release with enhanced campaign management, lead enrichment, list operations, whitelabel support, and analytics improvements across the Success.ai platform. View v2 API Reference →

✦ Added
  • POST /v2/campaign/create - Create a new outreach campaign
  • POST /v2/campaign/sequence-create - Create email sequences within a campaign
  • POST /v2/campaign/variants-create - Create A/B test variants for sequences
  • PUT /v2/campaign/sequences/{id} - Update an existing campaign sequence
  • DELETE /v2/campaign/sequences-delete - Delete a campaign sequence
  • DELETE /v2/campaign/variants-delete - Delete a sequence variant
  • POST /v2/campaign/set/schedules - Configure campaign sending schedules
  • POST /v2/campaign/launch - Launch a campaign
  • POST /v2/campaign/pause - Pause an active campaign
  • POST /v2/enrich/by-details - Enrich lead data by providing known details
  • POST /v2/list/create/people - Create a people list
  • POST /v2/list/create/company - Create a company list
  • POST /v2/list/delete/people - Delete a people list
  • POST /v2/list/delete/company - Delete a company list
  • GET /v2/list/get - Get list details by ID
  • GET /v2/list/all - Get all lists with pagination
  • GET /v2/list/leads - Get leads from a list
  • GET /v2/list/companies - Get companies from a list
  • POST /v2/list/add/leads - Add leads to a list
  • POST /v2/list/add/companies - Add companies to a list
  • POST /v2/list/remove/leads - Remove leads from a list
  • POST /v2/list/remove/companies - Remove companies from a list
  • POST /v2/list/send-to-campaign - Send a list directly to a campaign
  • GET /v2/list/export - Export list data
  • POST /v2/whitelabel/register - Register a whitelabel sub-user
  • POST /v2/whitelabel/add-plan - Create a custom whitelabel plan
  • POST /v2/whitelabel/user/{subUserId}/assign-plan/{planId} - Assign a plan to a sub-user
  • GET /v2/whitelabel/get-plan - Get custom plan details
  • GET /v2/whitelabel/user/{email} - Look up a whitelabel user by email
⟳ Changed
  • All endpoint base paths moved from /v1 to /v2
  • Standardized error response format with field-level validation details across all modules
v1 Stable January 10, 2026

Initial release of the Success.ai REST API with campaign management, email account management, analytics, lead finder, contact management, and API key authentication. View v1 API Reference →

✦ Added
  • GET /v1/authenticate - Test API key authentication
  • GET /v1/campaign/list - List all campaigns with pagination
  • GET /v1/campaign/get/name - Get campaign name by ID
  • GET /v1/campaign/get/status - Get campaign status
  • GET /v1/campaign/get/accounts - Get email accounts linked to a campaign
  • POST /v1/campaign/set/name - Update campaign name
  • POST /v1/campaign/set/accounts - Set campaign email accounts
  • POST /v1/campaign/add/account - Add an email account to a campaign
  • POST /v1/campaign/remove/accounts - Remove email accounts from a campaign
  • GET /v1/account/list - List all connected email accounts
  • GET /v1/account/status - Get email account connection status
  • POST /v1/account/vitals - Get account vitals (deliverability, reputation)
  • POST /v1/account/warmup/enable - Enable email warmup for an account
  • POST /v1/account/warmup/pause - Pause email warmup for an account
  • DELETE /v1/account/delete - Remove a connected email account
  • GET /v1/analytics/campaign/summary - Get campaign analytics summary with graph data
  • GET /v1/analytics/campaign/count - Get campaign count metrics
  • GET /v1/analytics/account/warmup/summary - Get account warmup summary
  • GET /v1/analytics/account/campaign/count - Get emails sent today per account
  • POST /v1/contact/add - Add a contact/lead to the system
  • GET /v1/contact/get - Retrieve contact details
  • POST /v1/contact/delete - Delete a contact
  • POST /v1/contact/update/status - Update contact lead status
  • POST /v1/contact/data/update - Update custom contact variables
  • POST /v1/contact/data/set - Set custom contact variables
  • POST /v1/contact/data/remove - Remove custom contact variables
  • POST /v1/mixed_people/search - Search the lead database for people
  • POST /v1/company/find - Search for companies
  • POST /v1/people_verification/verify - Verify lead email addresses
  • POST /v1/people_enrichment/peopleEnrichment - Enrich people lead data
  • API key authentication via X-API-Key header on all endpoints
  • Per-second rate limiting on all API endpoints
  • Multiple server environments: Local, Staging, Production