Update Email Settings
curl --request PATCH \
--url https://api.example.com/v2/mailbox-settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"auto_assign": true,
"auto_assign_threshold": 123,
"matching_guidelines": "<string>",
"microsoft_enabled": true,
"google_enabled": true
}
'import requests
url = "https://api.example.com/v2/mailbox-settings"
payload = {
"auto_assign": True,
"auto_assign_threshold": 123,
"matching_guidelines": "<string>",
"microsoft_enabled": True,
"google_enabled": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
auto_assign: true,
auto_assign_threshold: 123,
matching_guidelines: '<string>',
microsoft_enabled: true,
google_enabled: true
})
};
fetch('https://api.example.com/v2/mailbox-settings', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'auto_assign' => true,
'auto_assign_threshold' => 123,
'matching_guidelines' => '<string>',
'microsoft_enabled' => true,
'google_enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v2/mailbox-settings"
payload := strings.NewReader("{\n \"auto_assign\": true,\n \"auto_assign_threshold\": 123,\n \"matching_guidelines\": \"<string>\",\n \"microsoft_enabled\": true,\n \"google_enabled\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.example.com/v2/mailbox-settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"auto_assign\": true,\n \"auto_assign_threshold\": 123,\n \"matching_guidelines\": \"<string>\",\n \"microsoft_enabled\": true,\n \"google_enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v2/mailbox-settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"auto_assign\": true,\n \"auto_assign_threshold\": 123,\n \"matching_guidelines\": \"<string>\",\n \"microsoft_enabled\": true,\n \"google_enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"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
}
}{
"type": "<string>",
"status": 123,
"title": "<string>",
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
],
"detail": "<string>"
}mailbox-settings
Update Email Settings
Update the centralized-inbox workflow knobs (auto-assign, threshold, matching guidelines) and the per-provider kill-switches. Provider connection and consent are managed via the /microsoft endpoints.
PATCH
/
v2
/
mailbox-settings
Update Email Settings
curl --request PATCH \
--url https://api.example.com/v2/mailbox-settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"auto_assign": true,
"auto_assign_threshold": 123,
"matching_guidelines": "<string>",
"microsoft_enabled": true,
"google_enabled": true
}
'import requests
url = "https://api.example.com/v2/mailbox-settings"
payload = {
"auto_assign": True,
"auto_assign_threshold": 123,
"matching_guidelines": "<string>",
"microsoft_enabled": True,
"google_enabled": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
auto_assign: true,
auto_assign_threshold: 123,
matching_guidelines: '<string>',
microsoft_enabled: true,
google_enabled: true
})
};
fetch('https://api.example.com/v2/mailbox-settings', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'auto_assign' => true,
'auto_assign_threshold' => 123,
'matching_guidelines' => '<string>',
'microsoft_enabled' => true,
'google_enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v2/mailbox-settings"
payload := strings.NewReader("{\n \"auto_assign\": true,\n \"auto_assign_threshold\": 123,\n \"matching_guidelines\": \"<string>\",\n \"microsoft_enabled\": true,\n \"google_enabled\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.example.com/v2/mailbox-settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"auto_assign\": true,\n \"auto_assign_threshold\": 123,\n \"matching_guidelines\": \"<string>\",\n \"microsoft_enabled\": true,\n \"google_enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v2/mailbox-settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"auto_assign\": true,\n \"auto_assign_threshold\": 123,\n \"matching_guidelines\": \"<string>\",\n \"microsoft_enabled\": true,\n \"google_enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"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
}
}{
"type": "<string>",
"status": 123,
"title": "<string>",
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
],
"detail": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Update the centralized-inbox workflow knobs and provider kill-switches.
Response
Successful Response
How mail is transported — 'nylas' (OAuth sync/send) or 'sendgrid' (domain send).
Available options:
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
⌘I
