POST · Bearer

POST /api/v1/inboxes/:id/messages/batch-get

All endpoints · Markdown

Summary

Fetch 1 to 500 messages by id. Returns {object:"list", data, not_found}. Ids that are not in this inbox are listed in not_found and are not an error. Duplicate ids are 400 duplicate_message_ids. More than 500 ids are 400 too_many_ids. An empty message_ids array is 400 missing_message_ids. Another account's inbox is 404 inbox_not_found.

Request

{
  "message_ids": [
    "msg_a",
    "msg_b"
  ]
}

Response

The OpenAPI document does not declare a JSON response schema for this call. The summary is the contract.

Errors

  • HTTP 400 duplicate_message_ids
  • HTTP 400 too_many_ids
  • HTTP 400 missing_message_ids
  • HTTP 404 inbox_not_found

Idempotency

This route does not document Idempotency-Key or client_id.