curl --request POST \
--url https://api.example.com/v2/mailbox-settings/provider-health \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/v2/mailbox-settings/provider-health"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/v2/mailbox-settings/provider-health', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v2/mailbox-settings/provider-health",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v2/mailbox-settings/provider-health"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v2/mailbox-settings/provider-health")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v2/mailbox-settings/provider-health")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"transport_provider": "nylas",
"hybrid_mode_enabled": true,
"microsoft": {
"enabled": true,
"admin_consented": true,
"admin_consented_at": "2023-11-07T05:31:56Z",
"application_scopes": [
"<string>"
],
"delegated_scopes": [
"<string>"
],
"azure_tenant_id": "<string>",
"azure_client_id": "<string>",
"is_byo": true,
"uses_legacy_entra_app": true
},
"google": {
"enabled": true
},
"centralized_inbox": {
"auto_assign": true,
"auto_assign_threshold": 123,
"matching_guidelines": "<string>"
},
"sendgrid": {
"domain_name": "<string>",
"inbound_parse_hostname": "<string>",
"effective_inbound_hostname": "<string>",
"has_api_key": true
}
}Check Provider Health
Probes admin-consent state from Microsoft Graph and writes the result back to settings — catches out-of-band portal consent and revocation. Uses the tenant id recorded at consent time (admin consent returns the authoritative tenant); skips the probe if it’s missing. Returns the refreshed EmailSettings. Safe to poll.
curl --request POST \
--url https://api.example.com/v2/mailbox-settings/provider-health \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/v2/mailbox-settings/provider-health"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/v2/mailbox-settings/provider-health', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v2/mailbox-settings/provider-health",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v2/mailbox-settings/provider-health"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v2/mailbox-settings/provider-health")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v2/mailbox-settings/provider-health")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"transport_provider": "nylas",
"hybrid_mode_enabled": true,
"microsoft": {
"enabled": true,
"admin_consented": true,
"admin_consented_at": "2023-11-07T05:31:56Z",
"application_scopes": [
"<string>"
],
"delegated_scopes": [
"<string>"
],
"azure_tenant_id": "<string>",
"azure_client_id": "<string>",
"is_byo": true,
"uses_legacy_entra_app": true
},
"google": {
"enabled": true
},
"centralized_inbox": {
"auto_assign": true,
"auto_assign_threshold": 123,
"matching_guidelines": "<string>"
},
"sendgrid": {
"domain_name": "<string>",
"inbound_parse_hostname": "<string>",
"effective_inbound_hostname": "<string>",
"has_api_key": true
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
Successful Response
How mail is transported — 'nylas' (OAuth sync/send) or 'sendgrid' (domain send).
nylas, sendgrid The org's Microsoft mailbox connection: consent state and Entra details.
Show child attributes
Show child attributes
The org's Google mailbox connection state.
Show child attributes
Show child attributes
Routing / auto-assignment config for the centralized inbox.
Show child attributes
Show child attributes
SendGrid transport configuration.
Show child attributes
Show child attributes
