API by router
curl -X GET "https://loading/v1/email/inboxes" \ -H "X-Api-Key: string"[
{
"address": "string",
"created_at": "2019-08-24T14:15:22Z",
"customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
"display_name": "string",
"domain": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",
"is_active": true,
"is_default": true,
"rate_limit_per_day": 0,
"rate_limit_per_hour": 0,
"rate_limit_per_minute": 0,
"tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
"username": "string"
}
]{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Create Inbox
AuthorizationBearer <token>
In: header
Header Parameters
X-Api-Key?X-Api-Key
customer_id?Customer Id
display_name?Display Name
domain_id?Domain Id
Custom domain ID (uses verified domain instead of default)
instance_id?Instance Id
is_default?Is Default
Default
falserate_limit_per_day?Rate Limit Per Day
Default
2000Range
1 <= value <= 50000rate_limit_per_hour?Rate Limit Per Hour
Default
250Range
1 <= value <= 5000rate_limit_per_minute?Rate Limit Per Minute
Default
10Range
1 <= value <= 100usernameUsername
Match
^[a-z0-9][a-z0-9._-]*$Length
length <= 100Response Body
curl -X POST "https://loading/v1/email/inboxes" \ -H "X-Api-Key: string" \ -H "Content-Type: application/json" \ -d '{ "username": "string" }'{
"address": "string",
"created_at": "2019-08-24T14:15:22Z",
"customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
"display_name": "string",
"domain": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",
"is_active": true,
"is_default": true,
"rate_limit_per_day": 0,
"rate_limit_per_hour": 0,
"rate_limit_per_minute": 0,
"tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
"username": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Get Inbox
AuthorizationBearer <token>
In: header
Path Parameters
inbox_idInbox Id
Format
uuidHeader Parameters
X-Api-Key?X-Api-Key
Response Body
curl -X GET "https://loading/v1/email/inboxes/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "X-Api-Key: string"{
"address": "string",
"created_at": "2019-08-24T14:15:22Z",
"customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
"display_name": "string",
"domain": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",
"is_active": true,
"is_default": true,
"rate_limit_per_day": 0,
"rate_limit_per_hour": 0,
"rate_limit_per_minute": 0,
"tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
"username": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Delete Inbox
AuthorizationBearer <token>
In: header
Path Parameters
inbox_idInbox Id
Format
uuidHeader Parameters
X-Api-Key?X-Api-Key
Response Body
curl -X DELETE "https://loading/v1/email/inboxes/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "X-Api-Key: string"Empty
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}List Messages
AuthorizationBearer <token>
In: header
Path Parameters
inbox_idInbox Id
Format
uuidQuery Parameters
direction?Direction
limit?Limit
Default
50Range
1 <= value <= 200offset?Offset
Default
0Range
0 <= valueHeader Parameters
X-Api-Key?X-Api-Key
Response Body
curl -X GET "https://loading/v1/email/inboxes/497f6eca-6276-4993-bfeb-53cbbbba6f08/messages?direction=string&limit=50&offset=0" \ -H "X-Api-Key: string"{}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Send Email
AuthorizationBearer <token>
In: header
Path Parameters
inbox_idInbox Id
Format
uuidHeader Parameters
X-Api-Key?X-Api-Key
cc?Cc
html_body?Html Body
in_reply_to?In Reply To
subjectSubject
Length
length <= 998text_body?Text Body
toTo
Items
1 <= itemsResponse Body
curl -X POST "https://loading/v1/email/inboxes/497f6eca-6276-4993-bfeb-53cbbbba6f08/send" \ -H "X-Api-Key: string" \ -H "Content-Type: application/json" \ -d '{ "subject": "string", "to": [ "string" ] }'{}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}