Skip to main content
POST
Connect Microsoft (BYO Entra app)

Authorizations

Authorization
string
header
required

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

Body

application/json

Connect the org via a bring-your-own (BYO) Entra app.

Default-app orgs don't use this — they go straight to the admin-consent flow against Stuut's shared app. This endpoint registers a Nylas credential for the customer's own Entra app, so all fields are required.

azure_tenant_id
string
required

Customer's Entra tenant GUID.

credentials
object
required

Customer's own Entra app credentials.

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.