ConnectCloud Developers

Turn a held, dropped, unrouted or failed mail into a ticket, or append it to itemId (desk:admin)

POST /api/desk/v1/mail-log/{id}/release

Module: Desk · operationId: releaseMailLogEntry · Tag: Mail · Auth: access token (Authorization: Bearer <accessToken>)

Parameters

Name In Type Required Description
id path string (uuid) yes

Request body

application/json

  • itemId (string): Item id or number

Example:

{
  "itemId": "#1"
}

Responses

  • 200 The new record (application/json)
  • 503 Desk receives no mail (code unavailable)

Fields of the 200 answer:

  • ai (object): Decisions of the AI: classify (unclear mail) and route (space of a new ticket)
    • classify (MailAIUse)
      • choice (string): What the AI chose
      • confidence (number): Confidence of the AI (0–1)
      • logId (string): AI call log record
      • used (boolean): The AI was asked
    • route (MailAIUse)
      • choice (string): What the AI chose
      • confidence (number): Confidence of the AI (0–1)
      • logId (string): AI call log record
      • used (boolean): The AI was asked
  • classification (string): What desk classified the mail as
  • commsMailId (string): Received mail in comms
  • createdAt (string (date-time)): When desk processed the mail
  • disposition (string): What desk made of the mail (one of created, appended, duplicate, bounce_processed, auto_dropped, bulk_dropped, loop_dropped, held_spam, held_rate, unrouted, failed, released)
  • emlDocumentId (string): DMS document of the original mail (.eml): set for received mails, and for sent mails once comms archived them (after the sent event); the file is a ticket file of source eml
  • entryId (string): Entry the mail became
  • from (string): Sender address
  • id (string): Id of the log record
  • itemId (string): Ticket created or appended to
  • itemNumber (integer): Number of that ticket
  • mailboxId (string): comms mailbox the mail came in through
  • reason (string): Why the mail was held, dropped or failed
  • receivedAt (string (date-time)): When the mail was received
  • subject (string): Subject

Example 200 answer:

{
  "ai": {
    "classify": {
      "choice": "spam",
      "confidence": 0.94,
      "logId": "4b0c1d2e-5f6a-4b7c-9d8e-0f1a2b3c4d01",
      "used": true
    },
    "route": {
      "used": false
    }
  },
  "classification": "spam",
  "commsMailId": "2a9b0c1d-3e4f-4a5b-8c7d-9e0f1a2b3c01",
  "createdAt": "2026-11-18T06:02:13Z",
  "disposition": "held_spam",
  "emlDocumentId": "3d0e1f2a-4b5c-4d6e-9f8a-0b1c2d3e4f09",
  "from": "angebote@gewinnspiel.example",
  "id": "1f8a9b0c-2d3e-4f4a-9b6c-8d9e0f1a2b01",
  "mailboxId": "3f0a1b2c-4d5e-4f6a-9b8c-0d1e2f3a4b01",
  "reason": "Absender ist neu, Text enthält nur einen Link",
  "receivedAt": "2026-11-18T06:02:11Z",
  "subject": "Ihr Gewinn wartet"
}

Example request

curl -X POST 'https://api.mbcom.cloud/api/desk/v1/mail-log/3f2b8c1e-7d4a-4e9b-9c2a-5b1d6e8f0a12/release' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"itemId":"#1"}'

View as Markdown · Interactive reference · OpenAPI