The entire API V2 documentation is interactive and can be tested here. To the right side of every endpoint you will see a box with an example request. You can click on the "Try it" button to send a request to the server right from the docs. You will need to provide an API key by clicking the ApiKeyAuth_token blue text.
A campaign that can be sent to a list of recipients
Unique identifier for the campaign
Campaign Status
| Enum Value | Description |
|---|---|
| 0 | Draft |
| 1 | Active |
| 2 | Paused |
| 3 | Completed |
| 4 | Running Subsequences |
| -99 | Account Suspended |
| -1 | Accounts Unhealthy |
| -2 | Bounce Protect |
Campaign schedule
Timestamp when the campaign was created
Timestamp when the campaign was last updated
List of sequences (the actual email copy). Even though this field is an array, only the first element is used, so please provide only one array item, and add the steps to that array
List of tags to use for sending emails
Whether to stop the campaign for the entire company(domain) when a lead replies
{ "id": "01959271-1baa-7c2d-a116-9d5564508e66", "name": "My First Campaign", "pl_value": 100, "status": 1, "is_evergreen": false, "campaign_schedule": { "start_date": "2025-03-14T02:17:21.065Z", "end_date": "2025-03-14T02:17:21.065Z", "schedules": [ … ] }, "sequences": [ { … } ], "timestamp_created": "2025-03-14T02:17:21.066Z", "timestamp_updated": "2025-03-14T02:17:21.066Z", "email_gap": 10, "random_wait_max": 10, "text_only": false, "email_list": [ "john@doe.com" ], "daily_limit": 100, "stop_on_reply": false, "email_tag_list": [ "01959271-1baa-7c2d-a116-9d5692d654bb" ], "link_tracking": true, "open_tracking": true, "stop_on_auto_reply": false, "daily_max_leads": 100, "prioritize_new_leads": false, "auto_variant_select": { "trigger": "click_rate" }, "match_lead_esp": false, "stop_for_company": false, "insert_unsubscribe_header": false, "allow_risky_contacts": false, "disable_bounce_protect": false, "cc_list": [ "john@doe.com" ], "bcc_list": [ "john@doe.com" ], "organization": "01959271-1baa-7c2d-a116-9d577372fd14" }
A campaign email, a reply, a manually sent email, or any other email that's visible in the Unibox
Timestamp when the email was added to our database. This is not the timestamp of the email itself, since the email could have been sent at a different time. Please check the timestamp_email field for the timestamp of the email.
The timestamp of the email, as provided by the email server. Please note that the timestamp is not always accurate, as it can be manipulated by the sender or the email server.
Unique email ID from the email server
Comma-separated list of recipient email addresses
An object containing the email body in HTML and text format
The workspace ID
The email account that was used to send the email. This needs to be validated to make sure it exists in the user workspace
The sender email address, populated based on the eaccount
The id of the campaign that the email is associated with (it can be null for manually sent emails)
The id of the campaign subsequence that the email is associated with (it can be null for manually sent emails)
The id of the list (if the lead is part of a list)
Email type based on the life cycle of the email
| Enum Value | Description |
|---|---|
| 1 | Sent from campaign |
| 2 | Received |
| 3 | Sent |
| 4 | Scheduled |
Identifier for the email thread. All the emails in the same thread have the same thread ID
A short preview of the email content (usually the first few lines of the email)
{ "id": "01959271-1bbb-7d12-ba12-3ffffd7d2f57", "timestamp_created": "2025-03-14T02:17:21.083Z", "timestamp_email": "2025-03-14T02:17:21.083Z", "message_id": "<example123@mail.gmail.com>", "subject": "Re: Your inquiry", "from_address_email": "sender@example.com", "to_address_email_list": "recipient@example.com", "cc_address_email_list": "cc@example.com", "bcc_address_email_list": "bcc@example.com", "reply_to": "replyto@example.com", "body": { "text": "This is a test email", "html": "<p>This is a test email</p>" }, "organization_id": "01959271-1bbb-7d12-ba12-400050d55c13", "campaign_id": "01959271-1bbb-7d12-ba12-4001c12d0970", "subsequence_id": "01959271-1bbb-7d12-ba12-40026f379fb3", "list_id": "01959271-1bbb-7d12-ba12-400364bb0011", "lead": "01959271-1bbb-7d12-ba12-400459646b03", "eaccount": "eaccount-123", "ue_type": 3, "step": "step-123", "is_unread": true, "is_auto_reply": false, "reminder_ts": "2025-03-14T02:17:21.083Z", "ai_interest_value": 0.75, "ai_assisted": 1, "is_focused": 1, "i_status": 0, "thread_id": "01959271-1bbb-7d12-ba12-4005ae7c04cd", "content_preview": "This is a preview of the email content.", "from_address_json": [], "to_address_json": [], "cc_address_json": [] }
A single email verification
The verification status.
| Enum Value | Description |
|---|---|
| pending | The verification is pending |
| verified | The verification is verified |
| invalid | The verification is invalid |
The request status. Do not use this field to determine the verification status. Please use verification_status instead to check the verification status
| Enum Value | Description |
|---|---|
| success | The verification was successful |
| error | The verification was unsuccessful |
Whether this is a catch-all email address
| Enum Value | Description |
|---|---|
| false | The email is not a catch-all |
| true | The email is a catch-all |
| pending | The catch-all status is pending |
The number of verification credits available after the verification
{ "status": "success", "email": "example@example.com", "verification_status": "pending", "catch_all": true, "credits": 100, "credits_used": 1 }