outbound

Embed

<a href="https://hermeticor.com/docs/ref-outbound"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/3a54f1ef-9d8b-4cc5-aeee-3401241a9434/social-card.svg?v=3e7ae33eec8b" alt="outbound" width="600" height="315"></a>

POSThttps://hermeticor.com/v1/outbound/mailboxes/bulk-action

Request body

application/json

connectionIdsstring[]required

actionstringrequired

pause | resume

{
  "connectionIds": [
    "string"
  ],
  "action": "pause"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/mailboxes/bulk-action" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"connectionIds":["string"],"action":"pause"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "done": 0,
  "failed": [
    {
      "id": "string",
      "error": "string"
    }
  ]
}

Schema

doneintegerrequired

failedFailedItem2[]required

Show child parameters

idstringrequired

errorstringrequired

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/outbound/mailboxes/bulk-action

POSThttps://hermeticor.com/v1/outbound/mailboxes/reconnect-failed

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/mailboxes/reconnect-failed" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "tested": 0,
  "recovered": 0,
  "items": [
    {
      "connectionId": "string",
      "name": "string",
      "health": "string"
    }
  ]
}

Schema

testedintegerrequired

recoveredintegerrequired

itemsobject[]required

Show child parameters

connectionIdstringrequired

namestringrequired

healthstringrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/mailboxes/bulk-action

5XX Default Response

Same as 4XX · POST /v1/outbound/mailboxes/bulk-action

POSThttps://hermeticor.com/v1/outbound/mailboxes/{id}/mark-fixed

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/mailboxes/{id}/mark-fixed" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "connectionId": "string",
  "health": "string",
  "resumed": true
}

Schema

connectionIdstringrequired

healthstringrequired

resumedbooleanrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/mailboxes/bulk-action

5XX Default Response

Same as 4XX · POST /v1/outbound/mailboxes/bulk-action

GEThttps://hermeticor.com/v1/outbound/mailboxes/domain-health

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/outbound/mailboxes/domain-health" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "domain": "string",
      "mailboxes": 0,
      "paused": 0,
      "sent": 0,
      "bounced": 0,
      "complaints": 0,
      "bounceRate": 0,
      "complaintRate": 0
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

domainstringrequired

mailboxesintegerrequired

Every active email connection sending from the domain: Gmail/Microsoft mailboxes, SMTP and email APIs alike

pausedintegerrequired

sentintegerrequired

bouncedintegerrequired

complaintsintegerrequired

bounceRatenumberrequired

complaintRatenumberrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/mailboxes/bulk-action

5XX Default Response

Same as 4XX · POST /v1/outbound/mailboxes/bulk-action

GEThttps://hermeticor.com/v1/outbound/mailboxes/{id}/daily

Parameters

fromstringquery

tostringquery

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/outbound/mailboxes/{id}/daily" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "day": "string",
      "sent": 0,
      "bounced": 0,
      "replied": 0,
      "complaints": 0,
      "opens": 0,
      "clicks": 0
    }
  ],
  "nextCursor": "string"
}

Schema

itemsHistoryItem[]required

Show child parameters

daystringrequired

sentintegerrequired

bouncedintegerrequired

repliedintegerrequired

complaintsintegerrequired

opensintegerrequired

clicksintegerrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/mailboxes/bulk-action

5XX Default Response

Same as 4XX · POST /v1/outbound/mailboxes/bulk-action

GEThttps://hermeticor.com/v1/outbound/mailboxes/{id}/campaigns

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/outbound/mailboxes/{id}/campaigns" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "sequenceId": "string",
      "name": "string",
      "status": "string",
      "via": "mailbox",
      "poolId": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

sequenceIdstringrequired

namestringrequired

statusstringrequired

viastringrequired

mailbox | pool

poolIdstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/mailboxes/bulk-action

5XX Default Response

Same as 4XX · POST /v1/outbound/mailboxes/bulk-action

GEThttps://hermeticor.com/v1/outbound/sequences/{id}/senders

The mailboxes this sequence sends from

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "connectionIds": [
    "string"
  ],
  "poolId": "string",
  "dedicated": true,
  "poolName": "string"
}

Schema

connectionIdsstring[]required

poolIdstringrequired

dedicatedbooleanrequired

poolNamestringrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/mailboxes/bulk-action

5XX Default Response

Same as 4XX · POST /v1/outbound/mailboxes/bulk-action

PUThttps://hermeticor.com/v1/outbound/sequences/{id}/senders

Replace the sequence sender list (several mailboxes get a pool of their own)

Parameters

idstringpathrequired

Request body

application/json

connectionIdsstring[]required

{
  "connectionIds": [
    "string"
  ]
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/outbound/sequences/{id}/senders" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"connectionIds":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/outbound/sequences/{id}/senders

4XX Default Response

Same as 4XX · POST /v1/outbound/mailboxes/bulk-action

5XX Default Response

Same as 4XX · POST /v1/outbound/mailboxes/bulk-action

POSThttps://hermeticor.com/v1/outbound/sequences/{id}/senders

Add mailboxes (by id or by tag) to the sequence sender list

Parameters

idstringpathrequired

Request body

application/json

connectionIdsstring[]

tagsstring[]

{
  "connectionIds": [
    "string"
  ],
  "tags": [
    "string"
  ]
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/sequences/{id}/senders" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"connectionIds":["string"],"tags":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/outbound/sequences/{id}/senders

4XX Default Response

Same as 4XX · POST /v1/outbound/mailboxes/bulk-action

5XX Default Response

Same as 4XX · POST /v1/outbound/mailboxes/bulk-action

DELETEhttps://hermeticor.com/v1/outbound/sequences/{id}/senders/{connectionId}

Remove one mailbox from the sequence sender list

Parameters

idstringpathrequired

connectionIdstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/outbound/sequences/{id}/senders

4XX Default Response

Same as 4XX · POST /v1/outbound/mailboxes/bulk-action

5XX Default Response

Same as 4XX · POST /v1/outbound/mailboxes/bulk-action

Next part

Updated Nov 8, 2026

Was this page helpful?