Sign in with the mailbox's Microsoft 365 connection and look up the folders of its address (comms:read; desk:admin its ticket mailboxes, hr:recruiting:manage its applicant mailboxes – another module's mailbox answers 404)
POST /api/comms/v1/mailboxes/{id}/check
Module: Comms · operationId: checkMailbox · Tag: Mailboxes · Auth: access token (Authorization: Bearer <accessToken>)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id |
path | string | yes |
Responses
- 200 Checks (
application/json) - 400 Error (
application/json) - 404 Error (
application/json)
Fields of the 200 answer:
checks(array of MailCheck): The single checks (sign-in, folders)detail(string): Detail of the resultlabel(string): What was checkedstatus(string): Result of the check (one ofsuccess,error)
ok(boolean): Every check succeeded
Example 200 answer:
{
"checks": [
{
"detail": "Die Verbindung „Microsoft 365 Muster IT“ hat sich angemeldet.",
"label": "Anmeldung bei Microsoft 365",
"status": "success"
},
{
"detail": "Gefunden: Posteingang, In Bearbeitung, Erledigt, Abgelehnt.",
"label": "Postfach support@muster-it.example",
"status": "success"
}
],
"ok": true
}
Example request
curl -X POST 'https://api.mbcom.cloud/api/comms/v1/mailboxes/string/check' \
-H "Authorization: Bearer $ACCESS_TOKEN"