SoldieGet API Key

API Documentation

Build powerful integrations with the Soldie REST API. Automate campaigns, sync contacts, and access analytics programmatically.

Quick Start

Base URL

https://api.soldie.io/v1

Authentication

All API requests require an API key in the Authorization header:

curl -H "Authorization: Bearer sk_live_abc123..." \
  https://api.soldie.io/v1/contacts

Get your API key from Account Settings → API

Rate Limits

1,000/hour
Starter Plan
10,000/hour
Pro Plan
Custom
Enterprise Plan

Rate limit info returned in response headers: X-RateLimit-Remaining

Core Endpoints

Contacts

GET/contacts

List all contacts with pagination

POST/contacts

Create a new contact

PUT/contacts/:id

Update contact details

Show example request →
POST /v1/contacts
{
  "email": "john@example.com",
  "first_name": "John",
  "last_name": "Doe",
  "company": "Acme Corp",
  "title": "VP Sales"
}

Campaigns

GET/campaigns

List all campaigns

POST/campaigns

Create and launch a campaign

GET/campaigns/:id/analytics

Get campaign performance metrics

Official SDKs

Python

pip install soldie

from soldie import Client

client = Client(api_key="sk_...")
contacts = client.contacts.list()
View Python docs →

JavaScript / TypeScript

npm install @soldie/sdk

import { Soldie } from '@soldie/sdk'

const soldie = new Soldie('sk_...')
const contacts = await soldie.contacts.list()
View JS docs →

Webhooks

Subscribe to real-time events like email opens, replies, and campaign completions.

Available Events:

  • • contact.created - New contact added
  • • email.sent - Email delivered
  • • email.opened - Recipient opened email
  • • email.replied - Prospect replied
  • • campaign.completed - Campaign finished

Need Help?

Our developer support team is here to help with integrations and technical questions.

Contact API Support