Mailboxes

Get a mailbox

Fetch a single mailbox by id. Poll this after create/restore until status becomes "connected". The response also carries the incoming-warmup fields (incoming_warmup_state and friends) describing whether warmup is actually arriving at this mailbox, and the read-channel fields (read_channel_state and friends) describing whether we can open the mailbox and read it at all. status and health_status cover the sending side only — a mailbox can be "connected" and "ok" while its inbox cannot be opened, so check read_channel_state before concluding a mailbox is fully working. campaigns / campaign_count list the campaigns this mailbox sends for, and campaign_stats its campaign sent / opened / clicked / replied / bounced for the last stats_days days (same as the list).

Required scope: mailboxes:read.

get/mailboxes/{id}

Request

  • Base URL: https://warmysender.com/api/v1
  • URL: https://warmysender.com/api/v1/mailboxes/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Mailbox id (UUID).

Query parameters

stats_daysinteger

Days covered by campaign_stats (1–365).

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.