Skip to main content
POST
Handle Admin Consent Callback

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

True if Microsoft returned admin_consent=True.

tenant
string
required

Authoritative tenant GUID returned by Microsoft's native admin-consent redirect.

state
string
required

The signed state token from the consent URL, echoed back.

scope
string | null

Scopes consented, space-delimited.

error
string | null

OAuth error code on failure.

error_description
string | null

Response

Successful Response

transport_provider
enum<string>
required

How mail is transported — 'nylas' (OAuth sync/send) or 'sendgrid' (domain send).

Available options:
nylas,
sendgrid
hybrid_mode_enabled
boolean
required
microsoft
object
required

The org's Microsoft mailbox connection: consent state and Entra details.

google
object
required

The org's Google mailbox connection state.

centralized_inbox
object
required

Routing / auto-assignment config for the centralized inbox.

sendgrid
SendGridSettings · object | null
required

SendGrid transport configuration.