connections

Embed

<a href="https://hermeticor.com/docs/ref-connections"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/f97af7f7-078d-4412-8c6a-b40f548f2c71/social-card.svg?v=3e7ae33eec8b" alt="connections" width="600" height="315"></a>

POSThttps://hermeticor.com/v1/connections/{id}/senders

Parameters

idstringpathrequired

Request body

application/json

channelstringrequired

email | sms | whatsapp

fromEmailstring

fromNamestring

replyTostring

phoneNumberstring

senderIdAlphastring

{
  "channel": "email",
  "fromEmail": "string",
  "fromName": "string",
  "replyTo": "string",
  "phoneNumber": "string",
  "senderIdAlpha": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/connections/{id}/senders" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"channel":"email","fromEmail":"string","fromName":"string","replyTo":"string","phoneNumber":"string","senderIdAlpha":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "connectionId": "string",
  "channel": "email",
  "fromEmail": "string",
  "fromName": "string",
  "replyTo": "string",
  "phoneNumber": "string",
  "senderIdAlpha": "string",
  "domain": "string",
  "verifiedAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

connectionIdstringrequired

channelstringrequired

email | sms | whatsapp | push | postcard

fromEmailstringrequired

fromNamestringrequired

replyTostringrequired

phoneNumberstringrequired

senderIdAlphastringrequired

domainstringrequired

verifiedAtstringrequired

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · POST /v1/connections/{id}/senders

DELETEhttps://hermeticor.com/v1/connections/{id}/senders/{senderId}

Parameters

idstringpathrequired

senderIdstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/connections/{id}/senders/{senderId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · POST /v1/connections/{id}/senders

5XX Default Response

Same as 4XX · POST /v1/connections/{id}/senders

PATCHhttps://hermeticor.com/v1/connections/{id}/senders/{senderId}

Parameters

idstringpathrequired

senderIdstringpathrequired

Request body

application/json

fromNamestring

replyTostring

{
  "fromName": "string",
  "replyTo": "string"
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/connections/{id}/senders/{senderId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fromName":"string","replyTo":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/connections/{id}/senders

4XX Default Response

Same as 4XX · POST /v1/connections/{id}/senders

5XX Default Response

Same as 4XX · POST /v1/connections/{id}/senders

POSThttps://hermeticor.com/v1/connections/{id}/senders/{senderId}/verify

Parameters

idstringpathrequired

senderIdstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/connections/{id}/senders/{senderId}/verify" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/connections/{id}/senders

4XX Default Response

Same as 4XX · POST /v1/connections/{id}/senders

5XX Default Response

Same as 4XX · POST /v1/connections/{id}/senders

GEThttps://hermeticor.com/v1/sending-domains

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/sending-domains" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "domain": "string",
      "spf": {},
      "dkim": {},
      "dmarc": {},
      "mx": {},
      "lastCheckedAt": "2024-01-01T00:00:00Z",
      "openTracking": true,
      "clickTracking": true,
      "verified": true,
      "records": [
        {
          "purpose": "ownership",
          "type": "TXT",
          "name": "string",
          "value": "string",
          "source": "hermetica",
          "note": "string"
        }
      ]
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem21[]required

Show child parameters

idstringrequired

domainstringrequired

spfrequired

dkimrequired

dmarcrequired

mxrequired

lastCheckedAtstringrequired

openTrackingboolean

clickTrackingboolean

verifiedboolean

recordsRecordsItem[]

Show child parameters

purposestringrequired

ownership | spf | dkim | dmarc

typestringrequired

TXT | CNAME

namestringrequired

valuestringrequired

sourcestringrequired

hermetica | provider

notestring

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/connections/{id}/senders

5XX Default Response

Same as 4XX · POST /v1/connections/{id}/senders

POSThttps://hermeticor.com/v1/sending-domains

Request body

application/json

domainstringrequired

{
  "domain": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/sending-domains" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "domain": "string",
  "spf": {},
  "dkim": {},
  "dmarc": {},
  "mx": {},
  "lastCheckedAt": "2024-01-01T00:00:00Z",
  "openTracking": true,
  "clickTracking": true,
  "verified": true,
  "records": [
    {
      "purpose": "ownership",
      "type": "TXT",
      "name": "string",
      "value": "string",
      "source": "hermetica",
      "note": "string"
    }
  ]
}

Schema

idstringrequired

domainstringrequired

spfrequired

dkimrequired

dmarcrequired

mxrequired

lastCheckedAtstringrequired

openTrackingboolean

clickTrackingboolean

verifiedboolean

recordsRecordsItem[]

Show child parameters

purposestringrequired

ownership | spf | dkim | dmarc

typestringrequired

TXT | CNAME

namestringrequired

valuestringrequired

sourcestringrequired

hermetica | provider

notestring

4XX Default Response

Same as 4XX · POST /v1/connections/{id}/senders

5XX Default Response

Same as 4XX · POST /v1/connections/{id}/senders

POSThttps://hermeticor.com/v1/sending-domains/{id}/check

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/sending-domains/{id}/check" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/sending-domains

4XX Default Response

Same as 4XX · POST /v1/connections/{id}/senders

5XX Default Response

Same as 4XX · POST /v1/connections/{id}/senders

GEThttps://hermeticor.com/v1/sender-pools

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/sender-pools" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "channel": "email",
      "strategy": "round_robin",
      "members": [
        {
          "connectionId": "string",
          "senderIdentityId": null,
          "weight": 1
        }
      ],
      "matchProvider": true
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem22[]required

Show child parameters

idstringrequired

namestringrequired

channelstringrequired

email | sms | whatsapp | push | postcard

strategystringrequired

round_robin | weighted | least_used | sticky_per_recipient

membersMembersItem[]required

Show child parameters

connectionIdstringrequired

senderIdentityIdstringrequired

= null

weightintegerrequired

= 1

matchProviderbooleanrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/connections/{id}/senders

5XX Default Response

Same as 4XX · POST /v1/connections/{id}/senders

Next part

Updated Nov 8, 2026

Was this page helpful?