For the complete documentation index, see llms.txt. This page is also available as Markdown.

Update flags on multiple messages

Add and/or remove flags on multiple messages. Returns 200 when all UIDs succeed, 207 with per-UID outcome when some fail.

Update flags on multiple messages

post

Add and/or remove flags on multiple messages. Returns 200 when all UIDs succeed, 207 with per-UID outcome when some fail.

Authorizations
AuthorizationstringRequired

Bearer authentication using API tokens in the Authorization header.

Path parameters
mailboxResourceIdstringRequired

Resource ID of the managed mailbox the bearer token is authorized for.

Example: AC1a2b3c4d5e6f7g
folderstringRequired

Folder path (URL-encoded).

Example: INBOX
Body

Add and/or remove flags on multiple messages. At least one of addFlags or removeFlags must be set.

uidsinteger[] · min: 1 · max: 100Required

Message UIDs to update. 1-100 entries, each > 0.

Example: [42,43,44]
addFlagsstring[]Optional

IMAP flags to set on every listed message, e.g. \Seen, \Flagged, \Answered, $forwarded.

Example: ["\\Seen","\\Flagged","$forwarded"]
removeFlagsstring[]Optional

IMAP flags to clear from every listed message.

Example: ["\\Seen"]
Responses
200

All UIDs updated successfully.

application/json

Per-UID outcome of a bulk flag update. 200 when every UID succeeded, 207 when at least one failed.

post/api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/flags
POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/flags HTTP/1.1
Host: api.mail.hostinger.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "uids": [
    42,
    43,
    44
  ],
  "addFlags": [
    "\\Seen",
    "\\Flagged",
    "$forwarded"
  ],
  "removeFlags": [
    "\\Seen"
  ]
}
{
  "data": {
    "successful": [
      42,
      43
    ],
    "failed": [
      {
        "uid": 44,
        "reason": "Failed to update message flags"
      }
    ]
  }
}

Last updated

Was this helpful?