AGagentmail-to
inboxes > messages

Batch Update Messages

Changed on

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-ids <id1> --message-ids <id2> --add-labels read --remove-labels unread
post/v0/inboxes/{inbox_id}/messages/batch-update

Request

  • Base URL
    https://api.agentmail.to
  • URL
    https://api.agentmail.to/v0/inboxes/{inbox_id}/messages/batch-update
  • Auth
    HTTP bearer

Path parameters

inbox_idstring required

The ID of the inbox.

Request body

message_idsMessagesMessageId[] 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

Response with status 200

limitinteger required

Limit of number of items returned.

countinteger required

Number of items returned.

Changes

  • 3f5c7830c952Revision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • info

      the endpoint scheme security Bearer was added to the API

    • info

      the endpoint scheme security BearerAuth was removed from the API

    • info

      api tag inboxes > messages added

    • info

      api tag InboxesMessages removed

    • info

      request body became optional

  • 394ddcdd9c29Revision changes
    • info

      endpoint added