v34

latestOpenAPI 3.0.1raw.githubusercontent.com2026-07-21119235265.2 KB

InboxesMessages

Batch Update Messages

Apply one label change to up to 50 messages in a single request. The same add_labels and remove_labels apply to every message id, and at least one of them must be provided. The update is atomic: either all resolved messages are updated or none are. Missing or restricted ids are silently excluded; compare count against limit to detect exclusions.

CLI:

agentmail inboxes:messages batch-update --inbox-id <inbox_id> --message-id <id1> --message-id <id2> --add-label read --remove-label unread

post/v0/inboxes/{inbox_id}/messages/batch-update

Path parameters

inbox_idstring required

The ID of the inbox.

Request body

message_idsMessageId[] required

IDs of messages to update. Maximum 50 ids per request. Duplicates are rejected with a validation error. IDs not found in the inbox (including cross-inbox or permission-restricted) are silently excluded from the update; callers detect exclusions by comparing count against limit.

Response

limitinteger required

Limit of number of items returned.

countinteger required

Number of items returned.