Read the AI consent

GET/api/v1/mailbox/ai/consent
Requires amailbox token— it acts as one mailbox holder, not as the organization.

Current 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/consent
curl -X GET 'https://courier.mailyte.com/api/v1/mailbox/ai/consent' \
  -H 'Authorization: Bearer MAILBOX_TOKEN'

Response

Successful Response

  • dataobject
    • ai_assistant_opt_inboolean
    • ai_training_opt_inboolean
    • ai_terms_versionstring or null
    • ai_assistant_opted_in_atstring or null
    • current_terms_versionstring
    • document_urlstring or null

      A signed record of the decision.

200application/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

StatusWhen
401No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`.
403The 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.