Accept the AI terms

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

Records the holder's acceptance of the current terms (terms_version from GET /ai/terms). accept_training is a separate, optional choice.

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.
409 The terms changed since they were read; show the current ones.
422 accept_assistant must be true (withdraw with DELETE /ai/consent).

Request body

  • accept_assistantbooleanrequired

    Must be true: accepting the assistant terms.

  • accept_trainingboolean

    Also allow use for improving the assistant. Optional, separate.

  • terms_versionstringrequired

    The version from GET /ai/terms that the holder read.

Request

POST/api/v1/mailbox/ai/consent
curl -X POST 'https://courier.mailyte.com/api/v1/mailbox/ai/consent' \
  -H 'Authorization: Bearer MAILBOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "accept_assistant": true,
    "accept_training": false,
    "terms_version": "2026-09"
  }'

Response

Successful Response

  • dataobject
    • document_urlstring
    • consent_idstring
200application/json
{
  "type": "success",
  "msg": "Consent recorded",
  "data": {
    "document_url": "/api/v1/mailbox/ai/consent/01JABC/document",
    "consent_id": "01JABC"
  }
}

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`.
409The terms changed since they were read; show the current ones.
422`accept_assistant` must be true (withdraw with `DELETE /ai/consent`).

Every status, with what causes it and what to do, is on the error reference.