Mailwurf

Inboxes

GET
/v1/inboxes

Authorization

AuthorizationBearer <token>

Organization API key (mw_live_…).

In: header

Query Parameters

address*string

Full recipient address, case-insensitive.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/inboxes?address=string"
{  "id": "string",  "address": "string",  "kind": "temporary",  "created_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z"}
POST
/v1/inboxes

Creates one isolated temporary inbox. Custom address is rejected. The returned address is {id}@{mail domain}. Expires after one hour.

Authorization

AuthorizationBearer <token>

Organization API key (mw_live_…).

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Empty object. Custom address is not supported.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/v1/inboxes" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "address": "string",  "kind": "temporary",  "created_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z"}
GET
/v1/inboxes/{id}

Unknown ids or inboxes that do not belong to your API key return 404.

Authorization

AuthorizationBearer <token>

Organization API key (mw_live_…).

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/inboxes/string"
{  "id": "string",  "address": "string",  "kind": "temporary",  "created_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z"}
DELETE
/v1/inboxes/{id}

Deletes the inbox and its messages. Permanent inboxes return 403.

Authorization

AuthorizationBearer <token>

Organization API key (mw_live_…).

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X DELETE "https://example.com/v1/inboxes/string"
Empty