Create inboxes

POST/v1/inboxes

Creates a batch of inboxes on one domain. They are live within minutes of DNS verifying and start warming up straight away.

Parameters

domainstringRequired: A domain on your account, for example getacme.co.
patternstringRequired: How addresses are built. Use {first}, {last} and {f}.
sendersarrayRequired: Sender names, one per inbox.
tenantstring: Your own customer ID, for platforms.
poolstring: shared or a dedicated IP ID. Defaults to shared.

curl -X POST https://api.mailyard.com/v1/inboxes \
  -H "Authorization: Bearer $MAILYARD_KEY" \
  -d domain='getacme.co' \
  -d pattern='{first}.{last}' \
  -d senders='["Maya Chen", "Jon Park"]'

Response201 Created

{
  "data": {
    "batch": "bat_7k2m9x",
    "inboxes": 3,
    "status": "provisioning",
    "ready_in_seconds": 240
  }
}