API Reference

Fetch Mailbox By Email

This endpoint lets you look up a warm‑up campaign by the mailbox’s email address instead of its numeric campaignId. It is ideal when:

You only know the sender’s email (for example, when a user re‑opens your settings panel) and need to retrieve the associated campaign details quickly.

You want to check whether a mailbox is already connected before attempting to create a duplicate campaign.

You need the campaignId so that subsequent calls—such as starting or pausing warm‑up—can target the correct record.

Path Params
string
required

Email address You want to search.

Query Params
boolean
Defaults to false

Requests additional details about the owner.

boolean
Defaults to false

Requests SMTP & IMAP details about the Campaign.

boolean

Requests Ram up details about the Campaign.

Headers
string
required

Any Uniquie string, timestap or UUID for Logging

string
required
Defaults to application/json

Expected Type for response

string
required
Defaults to multipart/form-data

Request Content-Type

Responses

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json