Get OAuth configuration

GET 
/v1/oauth/:mailer_id

Get OAuth configuration for a specific email service provider

Request

Path Parameters

mailer_id stringrequired

Mailer ID

Responses

200

OAuth configuration retrieved successfully

application/json

Schema

Schema

active boolean
config object
config_type string
connection_type string
email string
include_sent boolean
include_spam boolean
include_trash boolean
mailer_id string
name string
provider string
strict_replies boolean

webhook

object

event stringrequired

Possible values: [BASIC_IMAP]

headers object

method stringrequired

Possible values: [GET, POST, PUT, DELETE, PATCH]

webhook_url stringrequired

Example (from schema)

{
  "active": true,
  "config": {},
  "config_type": "gmail",
  "connection_type": "oauth",
  "email": "john.doe@example.com",
  "include_sent": true,
  "include_spam": true,
  "include_trash": true,
  "mailer_id": "oauth_1234567890",
  "name": "John Doe",
  "provider": "gmail",
  "strict_replies": true,
  "webhook": {
    "event": "BASIC_IMAP",
    "headers": {},
    "method": "GET",
    "webhook_url": "string"
  }
}

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
}

404

Email config not found

application/json

Schema

Schema

error string
success boolean

Example (from schema)

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

Loading...