API Reference

Connect Mailbox with SMTP

post
https://app.mailivery.io/api/v1/campaigns/smtp

Create a new warm-up mailbox (campaign) using direct SMTP/IMAP credentials — the right choice for self-hosted mail servers and any provider that doesn't offer OAuth. Send the request as multipart/form-data with the mailbox owner's identity, SMTP outbound settings, IMAP inbox settings, sending volume, and optional ramp-up configuration.

On success

A 200 response confirms the campaign was created. The response payload includes the new id (save it for all subsequent warm-up operations), plus the campaign's name, email, status, timezone, daily volume, response rate, owner details, dashboard URL, and creation/update timestamps.

Body Params
string
required
int32
required
0 to 200
Defaults to 10
int32
required
0 to 100
string
required
length ≤ 255
string
required
length ≤ 255
string
required
string
required
length ≤ 255
password
required
length ≤ 255
enum
required
Allowed:
string
required
length ≤ 255
string

If you do not pass this parameter in the request, Mailivery will assign the campaign to the account owner.

string
required
length ≤ 255
password
required
length ≤ 255
enum
required

Available Options are 465, 587, 25, 2525, 8025

Allowed:
string
required
boolean
Defaults to false
enum
Defaults to normal
Allowed:
string
Defaults to America/Chicago

If no timezone is passed, Mailivery will use the default timezone set at the team level.

enum
Allowed:
string | null
Headers
string
required

Any unique string, timestamp, or UUID for logging.

string
required
Defaults to multipart/form-data

Request Content-Type

string
required
Defaults to application/json

Expected Type for response

Responses

Updated 10 days ago

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

Updated 10 days ago