POST · Bearer

POST /api/v1/inboxes/batch

All endpoints · Markdown

Summary

Create count inboxes in one call. Optional prefix, labels, metadata (stored on every inbox; same limits as a single create; 400 invalid_metadata), status (active or paused), and ttl_hours or expires_at. count is capped per plan (Free 5, Starter 25, Pro 100). Temporary inboxes count toward the existing inbox limit. The daily cron deletes expired inboxes and they then stop counting. Paused inboxes keep counting until they expire or you delete them.

Request

{
  "count": 3,
  "prefix": "trial",
  "labels": [
    "signup"
  ],
  "metadata": {
    "run": "signup"
  },
  "ttl_hours": 24
}

Response

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

Errors

  • HTTP 400 invalid_metadata

Idempotency

This route does not document Idempotency-Key or client_id.