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/inbox/untracked

Replies that matched no send or prospect

Parameters

limitintegerquery

= 50

cursorstringquery

categorystringquery

connectionIdstringquery

assigneeUserIdstringquery

sequenceIdstringquery

unreadbooleanquery

labelstringquery

leadStatusstringquery

includeSnoozedbooleanquery

= false

importantbooleanquery

remindersbooleanquery

ignoredbooleanquery

archivedbooleanquery

snoozedbooleanquery

listIdstringquery

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/outbound/inbox/untracked" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "connectionId": "string",
      "fromAddr": "string",
      "toAddr": "string",
      "subject": "string",
      "text": "string",
      "receivedAt": "2024-01-01T00:00:00Z",
      "profileId": "string",
      "classification": "string",
      "classificationSource": "string",
      "oooUntil": "2024-01-01T00:00:00Z",
      "readAt": "2024-01-01T00:00:00Z",
      "assignedUserId": "string",
      "archived": true,
      "sourceKind": "string",
      "sourceId": "string",
      "stepKey": "string",
      "meta": {
        "category": "positive",
        "confidence": 0,
        "source": "rule",
        "labels": [
          "string"
        ],
        "snoozedUntil": "2024-01-01T00:00:00Z",
        "oooUntil": "2024-01-01T00:00:00Z",
        "referral": {
          "name": "string",
          "email": "string"
        },
        "machineCategory": "positive",
        "important": true,
        "ignored": true,
        "remindAt": "2024-01-01T00:00:00Z",
        "latencySec": 0
      },
      "profile": {
        "id": "string",
        "name": "string",
        "email": "string"
      }
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem83[]required

Show child parameters

idstringrequired

connectionIdstringrequired

fromAddrstringrequired

toAddrstringrequired

subjectstringrequired

textstringrequired

receivedAtstringrequired

profileIdstringrequired

classificationstringrequired

classificationSourcestringrequired

oooUntilstringrequired

readAtstringrequired

assignedUserIdstringrequired

archivedbooleanrequired

sourceKindstringrequired

sourceIdstringrequired

stepKeystringrequired

metaobjectrequired

Show child parameters

categorystringrequired

confidencenumberrequired

sourcestringrequired

rule | llm | manual

labelsstring[]required

snoozedUntilstringrequired

oooUntilstringrequired

referralobjectrequired

machineCategorystringrequired

importantboolean

ignoredboolean

remindAtstring

latencySecinteger

profileobjectrequired

Show child parameters

idstringrequired

namestringrequired

emailstringrequired

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/inbox/untracked

POSThttps://hermeticor.com/v1/outbound/send

Send one cold email from a chosen mailbox, outside any sequence (consent, suppression and caps still apply)

Request body

application/json

tostringrequired

connectionIdstringrequired

subjectstringrequired

textstringrequired

scheduledForstring

idempotencyKeystring

{
  "to": "string",
  "connectionId": "string",
  "subject": "string",
  "text": "string",
  "scheduledFor": "2024-01-01T00:00:00Z",
  "idempotencyKey": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/send" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to":"string","connectionId":"string","subject":"string","text":"string","scheduledFor":"2024-01-01T00:00:00Z","idempotencyKey":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

202 Default Response

Example

{
  "jobId": "string",
  "status": "queued",
  "reason": "string"
}

Schema

jobIdstringrequired

statusstringrequired

queued | blocked | deferred | duplicate

reasonstring

4XX Default Response

Same as 4XX · GET /v1/outbound/inbox/untracked

5XX Default Response

Same as 4XX · GET /v1/outbound/inbox/untracked

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

Review gate: let held prospects start (the given ones, or every held prospect)

Parameters

idstringpathrequired

Request body

application/json

profileIdsstring[]

{
  "profileIds": [
    "string"
  ]
}

Code samples

cURL

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

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/inbox/untracked

5XX Default Response

Same as 4XX · GET /v1/outbound/inbox/untracked

POSThttps://hermeticor.com/v1/outbound/prospects/bulk-owner

Give many prospects one owner (or clear it)

Request body

application/json

profileIdsstring[]required

ownerUserIdstringrequired

{
  "profileIds": [
    "string"
  ],
  "ownerUserId": "string"
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "updated": 0,
  "skipped": [
    "string"
  ]
}

Schema

updatedintegerrequired

skippedstring[]required

4XX Default Response

Same as 4XX · GET /v1/outbound/inbox/untracked

5XX Default Response

Same as 4XX · GET /v1/outbound/inbox/untracked

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

A read-only link to the outline of this sequence (7 days); anyone with the link can read it

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "url": "string",
  "expiresAt": "2024-01-01T00:00:00Z"
}

Schema

urlstringrequired

expiresAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/outbound/inbox/untracked

5XX Default Response

Same as 4XX · GET /v1/outbound/inbox/untracked

GEThttps://hermeticor.com/p/seq/{token}

Shared read-only outline of a sequence

Parameters

tokenstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/p/seq/{token}"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

"string"

4XX Default Response

Same as 4XX · GET /v1/outbound/inbox/untracked

5XX Default Response

Same as 4XX · GET /v1/outbound/inbox/untracked

POSThttps://hermeticor.com/v1/outbound/inbox/predict

Test how a reply would be sorted (interested, not interested, out of office...) without storing anything

Request body

application/json

subjectstring

textstringrequired

useAiboolean

= false

{
  "subject": "string",
  "text": "string",
  "useAi": false
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/inbox/predict" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"subject":"string","text":"string","useAi":false}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "category": "positive",
  "confidence": 0,
  "source": "rule",
  "label": "string",
  "oooUntil": "string",
  "rules": {
    "category": "positive",
    "confidence": 0
  },
  "aiAvailable": true,
  "aiConsulted": true
}

Schema

categorystringrequired

confidencenumberrequired

sourcestringrequired

rule | llm

labelstringrequired

oooUntilstringrequired

rulesobjectrequired

Show child parameters

categorystringrequired

confidencenumberrequired

aiAvailablebooleanrequired

aiConsultedbooleanrequired

4XX Default Response

Same as 4XX · GET /v1/outbound/inbox/untracked

5XX Default Response

Same as 4XX · GET /v1/outbound/inbox/untracked

Next part

Updated Nov 8, 2026

Was this page helpful?