Skip to Content
POST
/api/v1/mailboxes/{mailboxId}/messages/learn

Submits spam or ham training feedback for a batch of messages in a single request. Same per-message idempotence as the single form: a message already taught this class is answered accepted but not sent again.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Two credential kinds share this scheme; GET /api/v1/auth/whoami answers which one you hold and what it reaches.

oek_… API key (minted by POST /api/v1/api-keys; shown once at mint). role: account reaches the full account surface: the directory (domains, routes, patterns, api-keys, accounts, address lists) plus every mailbox the account owns. role: system additionally reaches the operator surface, which is documented separately.

oemp_… mailbox app password (minted by POST /api/v1/identities/{identityId}/credentials). Reaches ONE mailbox: its messages, labels, threads, search, sync, send, filters and PIM collections. Directory routes refuse it with 403 insufficient_scope.

Refusal vocabulary: a missing, malformed, expired, or revoked credential answers 401 unauthorized with a WWW-Authenticate: Bearer challenge; a VALID credential outside its scope answers 403 (insufficient_scope for an app password on a directory route, system_credentials_required where only the operator may call). The public routes (health, branding, token-in-path capabilities) declare security: [].

Path Parameters

mailboxId*string

Mailbox ULID identifier

Request Body

application/json
  1. body
class*string

Feedback classification ('spam' for junk, 'ham' for legitimate)

Value in"spam""ham"
ids*array<string>

Array of message IDs to train on

Items1 <= items <= 200

Response Body

Batch feedback accepted with per-message queue status

application/json
  1. response
results*array<>

List of training submission outcomes

Example Request
curl -X POST 'https://api.open.email/api/v1/mailboxes/string/messages/learn' \
  -H 'Content-Type: application/json' \
  -d '{
  "class": "spam",
  "ids": [
    "string"
  ]
}'
Example Response
{
  "results": [
    {
      "id": "string",
      "status": "accepted"
    }
  ]
}