API Reference

Connect SendGrid Mailbox

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

Connect a mailbox (campaign) that sends through SendGrid. SendGrid handles outbound delivery via its API, while IMAP is used for the reply inbox — so you supply your SendGrid SMTP credentials alongside standard IMAP settings for the receiving side. On success, Mailivery returns the new campaign object with its id, which you'll use for all subsequent warm-up operations.

Body Params
string
required
length ≤ 255
string
length ≤ 255
string
required
length ≤ 255
string
length ≤ 255

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

int32
required
0 to 2000
string
required
string
required
length ≤ 255
password
required
length ≤ 255
enum
required
Allowed:
string
required
length ≤ 255
int32
required
0 to 100
password
required
length ≤ 255
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 18 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 18 days ago