HydraCore
API by router

Email domains

List Email Domains

GET
/v1/email/domains

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/domains'
Example Response
[  {    "created_at": "2019-08-24T14:15:22Z",    "dns_records": [      {        "name": "string",        "priority": 0,        "record": "string",        "status": "string",        "ttl": "string",        "type": "string",        "value": "string"      }    ],    "domain": "string",    "from_email": "string",    "from_name": "string",    "full_from_address": "string",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "is_active": true,    "region": "string",    "resend_domain_id": "string",    "status": "string",    "updated_at": "2019-08-24T14:15:22Z",    "verified_at": "2019-08-24T14:15:22Z"  }]

Create Email Domain

POST
/v1/email/domains

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Header Parameters

X-Api-Key?string|null

Request Body

application/json
  1. body
domain*Domain

Custom domain name (e.g. mail.mattsplumbing.com.au)

Length3 <= length <= 255
from_email?|

Email prefix (e.g. 'noreply')

from_name?|

Display name in From: header

region?Region

Resend region for email delivery

Default"us-east-1"

Response Body

Successful Response

application/json
  1. response
created_at*Created At
Formatdate-time
dns_records?array<>|null
domain*Domain
from_email?string|null
from_name?string|null
full_from_address?string|null
id*Id
Formatuuid
is_active*Is Active
region*Region
resend_domain_id?string|null
status*Status
updated_at*Updated At
Formatdate-time
verified_at?|null
Example Request
curl -X POST 'https://example.com/v1/email/domains' \  -H 'Content-Type: application/json' \  -d '{  "domain": "string"}'
Example Response
{  "created_at": "2019-08-24T14:15:22Z",  "dns_records": [    {      "name": "string",      "priority": 0,      "record": "string",      "status": "string",      "ttl": "string",      "type": "string",      "value": "string"    }  ],  "domain": "string",  "from_email": "string",  "from_name": "string",  "full_from_address": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "is_active": true,  "region": "string",  "resend_domain_id": "string",  "status": "string",  "updated_at": "2019-08-24T14:15:22Z",  "verified_at": "2019-08-24T14:15:22Z"}

Get Active Sender

GET
/v1/email/domains/active-sender

Authorization

HTTPBearer
headerAuthorizationBearer <token>

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/domains/active-sender'
Example Response
{}

Update Email Domain

PATCH
/v1/email/domains/{domain_id}

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

domain_id*Domain Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Request Body

application/json
  1. body
from_email?string|null
from_name?string|null

Response Body

Successful Response

application/json
  1. response
created_at*Created At
Formatdate-time
dns_records?array<>|null
domain*Domain
from_email?string|null
from_name?string|null
full_from_address?string|null
id*Id
Formatuuid
is_active*Is Active
region*Region
resend_domain_id?string|null
status*Status
updated_at*Updated At
Formatdate-time
verified_at?|null
Example Request
curl -X PATCH 'https://example.com/v1/email/domains/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "created_at": "2019-08-24T14:15:22Z",  "dns_records": [    {      "name": "string",      "priority": 0,      "record": "string",      "status": "string",      "ttl": "string",      "type": "string",      "value": "string"    }  ],  "domain": "string",  "from_email": "string",  "from_name": "string",  "full_from_address": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "is_active": true,  "region": "string",  "resend_domain_id": "string",  "status": "string",  "updated_at": "2019-08-24T14:15:22Z",  "verified_at": "2019-08-24T14:15:22Z"}

Delete Email Domain

DELETE
/v1/email/domains/{domain_id}

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

domain_id*Domain Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

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

Verify Email Domain

POST
/v1/email/domains/{domain_id}/verify

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

domain_id*Domain Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

application/json
  1. response
created_at*Created At
Formatdate-time
dns_records?array<>|null
domain*Domain
from_email?string|null
from_name?string|null
full_from_address?string|null
id*Id
Formatuuid
is_active*Is Active
region*Region
resend_domain_id?string|null
status*Status
updated_at*Updated At
Formatdate-time
verified_at?|null
Example Request
curl -X POST 'https://example.com/v1/email/domains/497f6eca-6276-4993-bfeb-53cbbbba6f08/verify'
Example Response
{  "created_at": "2019-08-24T14:15:22Z",  "dns_records": [    {      "name": "string",      "priority": 0,      "record": "string",      "status": "string",      "ttl": "string",      "type": "string",      "value": "string"    }  ],  "domain": "string",  "from_email": "string",  "from_name": "string",  "full_from_address": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "is_active": true,  "region": "string",  "resend_domain_id": "string",  "status": "string",  "updated_at": "2019-08-24T14:15:22Z",  "verified_at": "2019-08-24T14:15:22Z"}

Email

Previous Page

Email inbound

Next Page