HydraCore
API by router

Email

List Inboxes

GET
/v1/email/inboxes

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://example.com/v1/email/inboxes'
Example Response
[  {    "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"  }]

Create Inbox

POST
/v1/email/inboxes

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Header Parameters

X-Api-Key?string|null

Request Body

application/json
  1. body
customer_id?|null
display_name?|null
domain_id?|

Custom domain ID (uses verified domain instead of default)

instance_id?|null
is_default?Is Default
Defaultfalse
rate_limit_per_day?Rate Limit Per Day
Range1 <= value <= 50000
Default2000
rate_limit_per_hour?Rate Limit Per Hour
Range1 <= value <= 5000
Default250
rate_limit_per_minute?Rate Limit Per Minute
Range1 <= value <= 100
Default10
username*Username
Match^[a-z0-9][a-z0-9._-]*$
Lengthlength <= 100

Response Body

Successful Response

application/json
  1. response
address*Address
created_at*Created At
Formatdate-time
customer_id*|null
display_name*string|null
domain*Domain
id*Id
Formatuuid
instance_id*|null
is_active*Is Active
is_default*Is Default
rate_limit_per_day*Rate Limit Per Day
rate_limit_per_hour*Rate Limit Per Hour
rate_limit_per_minute*Rate Limit Per Minute
tenant_id*Tenant Id
Formatuuid
username*Username
Example Request
curl -X POST 'https://example.com/v1/email/inboxes' \  -H 'Content-Type: application/json' \  -d '{  "username": "string"}'
Example Response
{  "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"}

Get Inbox

GET
/v1/email/inboxes/{inbox_id}

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

inbox_id*Inbox Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

application/json
  1. response
address*Address
created_at*Created At
Formatdate-time
customer_id*|null
display_name*string|null
domain*Domain
id*Id
Formatuuid
instance_id*|null
is_active*Is Active
is_default*Is Default
rate_limit_per_day*Rate Limit Per Day
rate_limit_per_hour*Rate Limit Per Hour
rate_limit_per_minute*Rate Limit Per Minute
tenant_id*Tenant Id
Formatuuid
username*Username
Example Request
curl -X GET 'https://example.com/v1/email/inboxes/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "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"}

Delete Inbox

DELETE
/v1/email/inboxes/{inbox_id}

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

inbox_id*Inbox Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

Example Request
curl -X DELETE 'https://example.com/v1/email/inboxes/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
Empty

List Messages

GET
/v1/email/inboxes/{inbox_id}/messages

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

inbox_id*Inbox Id
Formatuuid

Query Parameters

direction?string|null
limit?Limit
Range1 <= value <= 200
Default50
offset?Offset
Range0 <= value
Default0

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

application/json
  1. response
Example Request
curl -X GET 'https://example.com/v1/email/inboxes/497f6eca-6276-4993-bfeb-53cbbbba6f08/messages'
Example Response
{}

Send Email

POST
/v1/email/inboxes/{inbox_id}/send

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

inbox_id*Inbox Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Request Body

application/json
  1. body
cc?array<string>
html_body?string|null
in_reply_to?string|null
subject*Subject
Lengthlength <= 998
text_body?string|null
to*array<string>
Items1 <= items

Response Body

Successful Response

application/json
  1. response
Example Request
curl -X POST 'https://example.com/v1/email/inboxes/497f6eca-6276-4993-bfeb-53cbbbba6f08/send' \  -H 'Content-Type: application/json' \  -d '{  "subject": "string",  "to": [    "string"  ]}'
Example Response
{}

Edge routes

Previous Page

Email domains

Next Page