Copy Page
Prospi API
Campaigns
List campaigns
Create a campaign
Get campaign details
Delete a campaign
Update campaign status
Update campaign settings
Update campaign schedule
Rename a campaign
Duplicate a campaign
Remove leads from a campaign
Get aggregate campaign statistics
Get daily campaign statistics
Get sequence for a campaign
Update sequence steps
Preview email with variables resolved
Toggle a sequence variant active/inactive
Email Accounts
List email accounts
Bulk update email accounts
Delete an email account
Email Account Tags
List email account tags
Create an email account tag
Delete an email account tag
Lead Lists
List lead lists
Create a lead list
Get a lead list
Archive/delete a lead list
Import leads into a list
Trigger lead enrichment for a list
Rename a lead list
Delete leads from a list
Find Leads
Filter leads
Query leads with filters
Get a single lead
Get unique field values for filters
Get leads in a list
Get leads in a campaign
Import leads from CSV
Inbox
List inbox threads
Get a thread
Get messages in a thread
Send a reply in a thread
Get AI-suggested reply
Update thread status
DNC
List DNC entries
Import DNC list
Bulk delete DNC entries
Workspaces
Get current team/workspace
List all teams
Create a team
List team members
Invite a team member
Rename team
Delete team
Update member role
Remove a team member
Generate API key
Delete API key
Webhooks
Add or update a webhook
Test a webhook
Delete a webhook
User
Get current user profile
Update user name
Delete user account
Change password
Brand
Get brand settings
Update brand settings
Add custom domain
Remove custom domain
Billing
Get current plan
List available plans
List invoices
Create checkout session
Cancel subscription
Top up credits
AI
Generate cold email copy with AI
Domains
Generate domain variants
Purchase domains
Schemas
ObjectId
Pagination
Error
LoginRequest
GoogleLoginRequest
RegisterRequest
AuthResponse
ForgotPasswordRequest
ResetPasswordRequest
User
UpdateUserRequest
ChangePasswordRequest
Campaign
CreateCampaignRequest
UpdateCampaignStatusRequest
UpdateCampaignSettingsRequest
CampaignSchedule
UpdateCampaignScheduleRequest
RenameCampaignRequest
CampaignStatistics
CampaignDailyStats
RemoveLeadsFromCampaignRequest
Sequence
SequenceStep
SequenceVariant
UpdateSequenceRequest
ToggleVariantStatusRequest
EmailPreview
EmailAccount
BulkUpdateEmailAccountsRequest
EmailAccountTag
CreateEmailAccountTagRequest
LeadList
CreateLeadListRequest
RenameLeadListRequest
ImportLeadsToListRequest
DeleteLeadsFromListRequest
Lead
CreateLeadRequest
LeadFilterRequest
LeadFieldOptions
ChatThread
ChatMessage
SendReplyRequest
UpdateThreadStatusRequest
AiSuggestedReply
DncEntry
BulkDeleteDncRequest
Team
CreateTeamRequest
RenameTeamRequest
TeamMember
InviteMemberRequest
UpdateMemberRoleRequest
Webhook
UpsertWebhookRequest
ApiKeyResponse
Brand
UpdateBrandRequest
AddCustomDomainRequest
Plan
CurrentPlan
Invoice
CreateCheckoutRequest
CheckoutResponse
TopUpCreditsRequest
GenerateColdEmailsRequest
GeneratedEmails
GenerateDomainsRequest
GeneratedDomains
PurchaseDomainsRequest
ApiKeyResponse
Copy Page
{
"apiKey"
:
"string"
}