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

Request body

application/json

kindstringrequired

familystringrequired

namestringrequired

credentialsobjectrequired

purposesAllowedstring[]required

configobject

= {}

{
  "kind": "string",
  "family": "mailbox",
  "name": "string",
  "credentials": {},
  "purposesAllowed": [
    "marketing"
  ],
  "config": {}
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/connections" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"string","family":"mailbox","name":"string","credentials":{},"purposesAllowed":["marketing"],"config":{}}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "kind": "string",
  "family": "mailbox",
  "name": "string",
  "purposesAllowed": [
    "string"
  ],
  "capabilities": {
    "send": true,
    "scheduledSend": true,
    "deliveryEvents": true,
    "deliveryDelayEvents": true,
    "complaintEvents": true,
    "openTracking": true,
    "clickTracking": true,
    "suppressionSync": true,
    "templates": true,
    "idempotencyKey": true,
    "safeRetryOnUnknown": true,
    "batchSend": true,
    "customHeaders": true,
    "mms": true,
    "alphanumericSender": true,
    "returnsMessageId": true,
    "bounceEvents": "none",
    "inboundReplies": "none",
    "webhookAuth": "hmac",
    "rateLimit": {
      "perSecond": 0,
      "perMinute": 0,
      "perDay": 0,
      "concurrent": 0
    },
    "maxRecipientsPerCall": 0
  },
  "health": "healthy",
  "healthDetail": {},
  "lastSuccessAt": "2024-01-01T00:00:00Z",
  "dailyCap": 0,
  "hourlyCap": 0,
  "ramp": {},
  "timezone": "string",
  "sendingWindow": {},
  "config": {},
  "status": "active",
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

kindstringrequired

familystringrequired

namestringrequired

purposesAllowedstring[]required

capabilitiesobjectrequired

Show child parameters

sendbooleanrequired

scheduledSendbooleanrequired

deliveryEventsbooleanrequired

deliveryDelayEventsbooleanrequired

complaintEventsbooleanrequired

openTrackingbooleanrequired

clickTrackingbooleanrequired

suppressionSyncbooleanrequired

templatesbooleanrequired

idempotencyKeybooleanrequired

safeRetryOnUnknownbooleanrequired

batchSendbooleanrequired

customHeadersbooleanrequired

mmsbooleanrequired

alphanumericSenderbooleanrequired

returnsMessageIdbooleanrequired

bounceEventsstringrequired

none | parsed | native

inboundRepliesstringrequired

none | native | separate

webhookAuthstringrequired

rateLimitobjectrequired

Show child parameters

perSecondnumber

perMinutenumber

perDaynumber

concurrentnumber

maxRecipientsPerCallintegerrequired

healthstringrequired

healthy | degraded | failing | disconnected

healthDetailrequired

lastSuccessAtstringrequired

dailyCapnumberrequired

hourlyCapnumberrequired

ramprequired

timezonestringrequired

sendingWindowrequired

configobjectrequired

Adapter settings. After an automatic pause, pausedReason = {reason, metric, value, threshold, sample, at, by, resume}; resuming clears it.

statusstringrequired

active | paused | archived

createdAtstringrequired

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

GEThttps://hermeticor.com/v1/connections/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/connections

4XX Default Response

Same as 4XX · POST /v1/connections

5XX Default Response

Same as 4XX · POST /v1/connections

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

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/connections

4XX Default Response

Same as 4XX · POST /v1/connections

5XX Default Response

Same as 4XX · POST /v1/connections

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

Parameters

idstringpathrequired

Request body

application/json

namestring

credentialsobject

purposesAllowedstring[]

configobject

dailyCapinteger

hourlyCapinteger

timezonestring

sendingWindowobject

rampobject

{
  "name": "string",
  "credentials": {},
  "purposesAllowed": [
    "marketing"
  ],
  "config": {},
  "dailyCap": 0,
  "hourlyCap": 0,
  "timezone": "string",
  "sendingWindow": {},
  "ramp": {}
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/connections/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","credentials":{},"purposesAllowed":["marketing"],"config":{},"dailyCap":0,"hourlyCap":0,"timezone":"string","sendingWindow":{},"ramp":{}}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/connections

4XX Default Response

Same as 4XX · POST /v1/connections

5XX Default Response

Same as 4XX · POST /v1/connections

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

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true,
  "state": "healthy",
  "detail": {}
}

Schema

okbooleanrequired

statestringrequired

healthy | degraded | failing | disconnected

detailobject

4XX Default Response

Same as 4XX · POST /v1/connections

5XX Default Response

Same as 4XX · POST /v1/connections

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

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/connections

4XX Default Response

Same as 4XX · POST /v1/connections

5XX Default Response

Same as 4XX · POST /v1/connections

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

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/connections

4XX Default Response

Same as 4XX · POST /v1/connections

5XX Default Response

Same as 4XX · POST /v1/connections

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

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

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

Schema

itemsItemsItem20[]required

Show child parameters

idstringrequired

connectionIdstringrequired

channelstringrequired

email | sms | whatsapp | push | postcard

fromEmailstringrequired

fromNamestringrequired

replyTostringrequired

phoneNumberstringrequired

senderIdAlphastringrequired

domainstringrequired

verifiedAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/connections

5XX Default Response

Same as 4XX · POST /v1/connections

Next part

Updated Nov 8, 2026

Was this page helpful?