Initiate OAuth login flow

POST 
/v1/oauth/login

Initiates OAuth authentication flow for email service providers (Gmail, Outlook, etc.) to configure email sending/receiving capabilities. Can handle both new OAuth flows and token exchange flows.

Request

application/json

Body

required

OAuth login request payload

app_id stringrequired
exchange_token boolean
include_sent boolean
include_spam boolean
include_trash boolean
mailer_id string
redirect_uri string
state string
strict_replies boolean

token

object

access_token string

expires_in integer

id_token string

refresh_token string

scope string

token_type string
type string

webhook

object

headers object

method string

url string

Responses

200

OAuth login initiated successfully - returns authorization URL

application/json

Schema

Schema

success boolean
url string

Example (from schema)

{
  "success": true,
  "url": "https://example.com/oauth/callback"
}

400

Bad request - invalid input parameters or validation failed

application/json

Schema

Schema

error string
success boolean

Example (from schema)

{
  "error": "invalid request",
  "success": false
}

500

Internal server error - OAuth configuration or processing failed

application/json

Schema

Schema

error string
success boolean

Example (from schema)

{
  "error": "invalid request",
  "success": false
}

Loading...