Inboxes

Create inbox

post/v1/inboxes

Request

  • Base URL: https://api.deadsimple.email
  • URL: https://api.deadsimple.email/v1/inboxes
  • Auth: HTTP bearer

Headers

X-Workspace-Idstring uuid

Target a specific workspace. Required for account-wide API keys that want workspace-scoped results.

Request body

display_namestring
domainstring
local_partstring
tagsstring[]

Response

Inbox created with email address. When paid per request, the response also carries a payment header and, on a payer's first inbox, credentials.

Example response

{
  "data": {
    "payment": {
      "method": "stripe"
    }
  }
}

Changes

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