Withdraw AI consent
DELETE
/api/v1/mailbox/ai/consentWithdraws 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/consentcurl -X DELETE '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: 'DELETE',
headers: {
Authorization: 'Bearer MAILBOX_TOKEN',
},
});
const { data } = await response.json();import requests
response = requests.delete(
"https://courier.mailyte.com/api/v1/mailbox/ai/consent",
headers={"Authorization": "Bearer MAILBOX_TOKEN"},
)
data = response.json()["data"]<?php
$response = Http::withToken('MAILBOX_TOKEN')
->delete('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::Delete.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
dataobjectdocument_urlstringconsent_idstring
200
application/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
| 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.