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>

GEThttps://hermeticor.com/v1/outbound/mailbox-meta

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/mailbox-meta" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "connectionId": "string",
      "tags": [
        "string"
      ],
      "groupName": "string",
      "capJitterPct": 0,
      "domain": "string",
      "displayName": "string",
      "signature": "string",
      "bcc": "string",
      "trackingDomain": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

connectionIdstringrequired

tagsstring[]required

groupNamestringrequired

capJitterPctintegerrequired

domainstringrequired

displayNamestringrequired

signaturestringrequired

bccstringrequired

trackingDomainstringrequired

nextCursorstringrequired

4XX Default Response

Example

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

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-meta

PUThttps://hermeticor.com/v1/outbound/mailbox-meta/{id}

Parameters

idstringpathrequired

Request body

application/json

displayNamestring

tagsstring[]

groupNamestring

capJitterPctinteger

signaturestring

bccstring

trackingDomainstring

{
  "displayName": "string",
  "tags": [
    "string"
  ],
  "groupName": "string",
  "capJitterPct": 0,
  "signature": "string",
  "bcc": "string",
  "trackingDomain": "string"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/outbound/mailbox-meta/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"displayName":"string","tags":["string"],"groupName":"string","capJitterPct":0,"signature":"string","bcc":"string","trackingDomain":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-meta

5XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-meta

GEThttps://hermeticor.com/v1/outbound/domain-caps

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "domain": "string",
      "dailyCap": 0,
      "mailboxes": 0,
      "perMailbox": 0
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

domainstringrequired

dailyCapintegerrequired

mailboxesintegerrequired

perMailboxintegerrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-meta

5XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-meta

PUThttps://hermeticor.com/v1/outbound/domain-caps

Request body

application/json

domainstringrequired

dailyCapintegerrequired

{
  "domain": "string",
  "dailyCap": 0
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/outbound/domain-caps" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain":"string","dailyCap":0}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PUT /v1/outbound/mailbox-meta/{id}

4XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-meta

5XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-meta

DELETEhttps://hermeticor.com/v1/outbound/domain-caps/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PUT /v1/outbound/mailbox-meta/{id}

4XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-meta

5XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-meta

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

Request body

application/json

rowsobject[]required

Show child parameters

namestringrequired

emailstringrequired

fromNamestring

hoststringrequired

portinteger

= 587

secureboolean

= false

userstringrequired

passstringrequired

imapHoststring

imapPortinteger

= 993

imapSecureboolean

= true

imapUserstring

imapPassstring

pop3Hoststring

pop3Portinteger

= 995

pop3Secureboolean

= true

pop3Userstring

pop3Passstring

{
  "rows": [
    {
      "name": "string",
      "email": "string",
      "fromName": "string",
      "host": "string",
      "port": 587,
      "secure": false,
      "user": "string",
      "pass": "string",
      "imapHost": "string",
      "imapPort": 993,
      "imapSecure": true,
      "imapUser": "string",
      "imapPass": "string",
      "pop3Host": "string",
      "pop3Port": 995,
      "pop3Secure": true,
      "pop3User": "string",
      "pop3Pass": "string"
    }
  ]
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/mailboxes/bulk-connect" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"rows":[{"name":"string","email":"string","fromName":"string","host":"string","port":587,"secure":false,"user":"string","pass":"string","imapHost":"string","imapPort":993,"imapSecure":true,"imapUser":"string","imapPass":"string","pop3Host":"string","pop3Port":995,"pop3Secure":true,"pop3User":"string","pop3Pass":"string"}]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "created": [
    {
      "row": 0,
      "connectionId": "string"
    }
  ],
  "errors": [
    {
      "row": 0,
      "error": "string"
    }
  ]
}

Schema

createdobject[]required

Show child parameters

rowintegerrequired

connectionIdstringrequired

errorsErrorsItem2[]required

Show child parameters

rowintegerrequired

errorstringrequired

4XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-meta

5XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-meta

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

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "step": 0,
      "ready": true,
      "leader": "string",
      "variants": [
        {
          "key": "string",
          "sent": 0,
          "replied": 0,
          "positive": 0,
          "replyRate": 0,
          "weight": 0,
          "suggestedWeight": 0
        }
      ]
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

stepintegerrequired

readybooleanrequired

leaderstringrequired

variantsobject[]required

Show child parameters

keystringrequired

sentintegerrequired

repliedintegerrequired

positiveintegerrequired

replyRatenumberrequired

weightintegerrequired

suggestedWeightintegerrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-meta

5XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-meta

POSThttps://hermeticor.com/v1/outbound/sequences/{id}/prospects/{profileId}/pause

Parameters

idstringpathrequired

profileIdstringpathrequired

Request body

application/json

reasonstring

= manual

{
  "reason": "manual"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/sequences/{id}/prospects/{profileId}/pause" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"manual"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "affected": 0,
  "skipped": []
}

Schema

affectedintegerrequired

skippedSkippedItem[]required

= []

Show child parameters

profileIdstringrequired

reasonstringrequired

4XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-meta

5XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-meta

POSThttps://hermeticor.com/v1/outbound/sequences/{id}/prospects/{profileId}/resume

Parameters

idstringpathrequired

profileIdstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/outbound/sequences/{id}/prospects/{profileId}/pause

4XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-meta

5XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-meta

Next part

Updated Nov 8, 2026

Was this page helpful?