Skip to main content
POST
/
v1
/
inboxes
Create a new inbox
curl --request POST \
  --url https://api.distranmail.com/v1/inboxes/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "EMAIL_INBOX",
  "email": "[email protected]",
  "metadata": {
    "department": "Support",
    "team": "Customer Success"
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "EMAIL_INBOX",
  "status": "ACTIVE",
  "email": "[email protected]",
  "display_name": "<string>",
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
type
enum<string>
required

Type of email inbox

Available options:
EMAIL_INBOX
​
email
string
​
metadata
object

Response

Inbox created successfully

​
id
string<uuid>
required

Unique identifier for the inbox

​
account_id
string<uuid>
required

Account ID that owns this inbox

​
type
enum<string>
required

Type of email inbox

Available options:
EMAIL_INBOX
​
status
enum<string>
required

Current status of the inbox

Available options:
ACTIVE,
INACTIVE,
PENDING_VERIFICATION,
FAILED
​
email
string<email>
required

Email address associated with this inbox

​
display_name
string

Human-readable name for the inbox

Maximum string length: 100
​
metadata
object

Additional metadata for the inbox

​
created_at
string<date-time>
​
updated_at
string<date-time>