Connect a Google Mailbox via XOAUTH2

post

https://app.mailivery.io/api/v1/campaigns/google-oauth

Create a Gmail / Google Workspace campaign using the OAuth refresh-token flow (XOAUTH2).

Invite-only. Contact support to enable access. Returns 403 GOOGLE_OAUTH_NOT_ENABLED if your account is not enrolled.

The partner performs the Google OAuth consent flow and supplies Mailivery with a long-lived google_refresh_token plus an initial google_token. Partners do not need to push fresh access tokens over the lifetime of the campaign. The Google scope must be the full https://mail.google.com/ scope; narrower scopes are not sufficient for IMAP XOAUTH2.

Body Params

google_token

string

required

Google OAuth2 access token. May be short-lived — Mailivery refreshes it before every send, read, and connection check.

google_refresh_token

string

required

Long-lived OAuth2 refresh token issued with the full https://mail.google.com/ scope.

string

required

email_per_day

string

required

first_name

string

required

last_name

string

owner_email

string

response_rate

string

required

with_rampup

boolean

Defaults to false

rampup_speed

enum

Defaults to normal

Allowed:

timezone

string

Defaults to America/Chicago

If No timezone has passed. Mailivery will user defaultg timezone set on Team level.

sending_schedule_presets

enum

Allowed:

200STATUS 200

400STATUS 400

403STATUS 403

404STATUS 404

422STATUS 422