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.
Add and/or remove flags on multiple messages. Returns 200 when all UIDs succeed, 207 with per-UID outcome when some fail.
Bearer authentication using API tokens in the Authorization header.
Resource ID of the managed mailbox the bearer token is authorized for.
AC1a2b3c4d5e6f7gFolder path (URL-encoded).
INBOXAdd and/or remove flags on multiple messages. At least one of addFlags or removeFlags must be set.
Message UIDs to update. 1-100 entries, each > 0.
[42,43,44]IMAP flags to set on every listed message, e.g. \Seen, \Flagged, \Answered, $forwarded.
["\\Seen","\\Flagged","$forwarded"]IMAP flags to clear from every listed message.
["\\Seen"]All UIDs updated successfully.
Per-UID outcome of a bulk flag update. 200 when every UID succeeded, 207 when at least one failed.
Some UIDs failed; see body for per-UID outcome.
Missing or invalid credentials.
Token is not authorized to manage the requested mailbox.
Request payload failed validation. params maps field name to an array of error messages.
Server-side failure.
Upstream service is unavailable or returned an unexpected response.
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?