Withdraw AI consent

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

Withdraws both the assistant and training decisions and writes a 'revoked' ledger entry with its own receipt document. Idempotent: with nothing to withdraw it succeeds without writing anything.

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

DELETE/api/v1/mailbox/ai/consent
curl -X DELETE 'https://courier.mailyte.com/api/v1/mailbox/ai/consent' \
  -H 'Authorization: Bearer MAILBOX_TOKEN'

Response

Successful Response

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

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.