Read the AI consent
GET
/api/v1/mailbox/ai/consentCurrent opt-in flags, the version accepted, when, the version currently in force, and the URL of the consent document. Deliberately available regardless of entitlement or org policy — reading one's own consent state is never gated.
Errors
| Status | When |
|---|---|
401 |
No token, or the session expired or was signed out. Sign in again with POST /mailbox-auth/login. |
403 |
The account has a temporary password: until POST /security/password succeeds, every other call answers this with error_code: password_change_required. |
Request
GET
/api/v1/mailbox/ai/consentcurl -X GET 'https://courier.mailyte.com/api/v1/mailbox/ai/consent' \
-H 'Authorization: Bearer MAILBOX_TOKEN'const response = await fetch('https://courier.mailyte.com/api/v1/mailbox/ai/consent', {
method: 'GET',
headers: {
Authorization: 'Bearer MAILBOX_TOKEN',
},
});
const { data } = await response.json();import requests
response = requests.get(
"https://courier.mailyte.com/api/v1/mailbox/ai/consent",
headers={"Authorization": "Bearer MAILBOX_TOKEN"},
)
data = response.json()["data"]<?php
$response = Http::withToken('MAILBOX_TOKEN')
->get('https://courier.mailyte.com/api/v1/mailbox/ai/consent');
$data = $response->json('data');require "net/http"
require "json"
uri = URI("https://courier.mailyte.com/api/v1/mailbox/ai/consent")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer MAILBOX_TOKEN"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }Response
Successful Response
dataobjectai_assistant_opt_inbooleanai_training_opt_inbooleanai_terms_versionstring or nullai_assistant_opted_in_atstring or nullcurrent_terms_versionstringdocument_urlstring or nullA signed record of the decision.
200
application/json{
"type": "success",
"msg": "AI consent state",
"data": {
"ai_assistant_opt_in": true,
"ai_training_opt_in": false,
"ai_terms_version": "2026-09",
"ai_assistant_opted_in_at": "2026-10-02T08:30:00+00:00",
"current_terms_version": "2026-09",
"document_url": "/api/v1/mailbox/ai/consent/01JABC/document"
}
}Returned inside the standard envelope.
Errors
| Status | When |
|---|---|
401 | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |
403 | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |
Every status, with what causes it and what to do, is on the error reference.