Connect a Google Mailbox (OAuth)

post

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

Connect a Gmail or Google Workspace mailbox (campaign) using the OAuth 2.0 refresh-token flow. Unlike Connect a Google Mailbox (App Password), the mailbox owner authorizes through Google's consent screen and never generates or shares an app password.

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.

Technical detail. Mailivery authenticates to Gmail's IMAP and SMTP servers using the XOAUTH2 SASL mechanism, exchanging the stored refresh token for short-lived access tokens as needed. 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 is passed, Mailivery will use the default timezone set at the team level.

sending_schedule_presets

enum

Allowed:

200STATUS 200

400STATUS 400

403STATUS 403

404STATUS 404

422STATUS 422