Connect Mailbox with SMTP

This endpoint allows you to create a new SMTP mailbox (campaign).

The request should be sent as an HTTP POST to {{host}}/campaigns/smtp with the form-data request body type.

The request payload should include parameters for first name, last name, email, owner email, SMTP and IMAP configurations, email sending settings, and ramp-up details.

Response upon successful creation of the campaign,

-The API responds with a success status, a 200 status code, and a message indicating the successful creation of the campaign.
-The response data includes the ID of the campaign, first name, last name, email, status code, timezone, email sending and response rate, owner details, dashboard URL, and timestamps for creation and update.

This endpoint allows you to create a new SMTP mailbox (campaign).

The request should be sent as an HTTP POST to {{host}}/campaigns/smtp with the form-data request body type.

The request payload should include parameters for first name, last name, email, owner email, SMTP and IMAP configurations, email sending settings, and ramp-up details.

Response upon successful creation of the campaign:

  • the API responds with a success status, a 200 status code, and a message indicating the successful creation of the campaign.
  • The response data includes the ID of the campaign, first name, last name, email, status code, timezone, email sending and response rate, owner details, dashboard URL, and timestamps for creation and update.
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 paramater in request Mailivery will assign the campaign to 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 has passed. Mailivery will user defaultg timezone set on Team level.

enum
Allowed:
string | null
Headers
string
required

Any Uniquie string, timestap 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

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