1. Campaigns
Prospi API
  • Campaigns
    • List campaigns
      GET
    • Create a campaign
      POST
    • Get campaign details
      GET
    • Delete a campaign
      DELETE
    • Update campaign status
      PUT
    • Update campaign settings
      PUT
    • Update campaign schedule
      PUT
    • Rename a campaign
      PUT
    • Duplicate a campaign
      POST
    • Remove leads from a campaign
      DELETE
    • Get aggregate campaign statistics
      GET
    • Get daily campaign statistics
      GET
    • Get sequence for a campaign
      GET
    • Update sequence steps
      PUT
    • Preview email with variables resolved
      GET
    • Toggle a sequence variant active/inactive
      PUT
    • Import leads from a lead list into a campaign
      POST
    • List available variables for a campaign
      GET
  • Email Accounts
    • List email accounts
      GET
    • Bulk update email accounts
      PUT
    • Delete an email account
      DELETE
  • Email Account Tags
    • List email account tags
      GET
    • Create an email account tag
      POST
    • Delete an email account tag
      DELETE
  • Lead Lists
    • List lead lists
      GET
    • Create a lead list
      POST
    • Get a lead list
      GET
    • Archive/delete a lead list
      DELETE
    • Import leads into a list
      POST
    • Trigger lead enrichment for a list
      PUT
    • Rename a lead list
      PUT
    • Delete leads from a list
      DELETE
  • 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
    • List DNC entries
    • Import DNC list from CSV
    • 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
    • Add 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/Mailboxes
    • Generate domain variants
    • Purchase domains
    • Purchase mailboxes
  • Leads
    • Search leads
    • List saved leads
    • Get distinct field values
    • Get leads in a list
    • Get leads in a campaign
    • Get a single lead
    • Import leads from CSV
  • 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
  1. Campaigns

Preview email with variables resolved

GET
/sequences/69fc59858009c6f1954a9c8a/preview-email

Request

Authorization
API Key
Add parameter in header
x-api-key
Example:
x-api-key: ********************
or
Query Params

Header Params

Responses

🟢200
application/json
Email preview
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/sequences/69fc59858009c6f1954a9c8a/preview-email?step=0&variant=0' \
--header 'x-workspace;' \
--header 'x-api-key: <api-key>'
Response Response Example
{
    "subject": "string",
    "body": "string"
}
Modified at 2026-05-07 09:55:30
Previous
Update sequence steps
Next
Toggle a sequence variant active/inactive
Built with