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/{id}/resume

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

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/{id}/resume

GEThttps://hermeticor.com/v1/outbound/message-reviews

Messages waiting for approval, rendered for each prospect

Parameters

sequenceIdstringquery

limitintegerquery

= 50

cursorstringquery

staleAfterHoursintegerquery

= 48

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "sequenceId": "string",
      "sequenceName": "string",
      "stepKey": "string",
      "profileId": "string",
      "profileEmail": "string",
      "profileName": "string",
      "subject": "string",
      "text": "string",
      "edited": true,
      "queuedAt": "2024-01-01T00:00:00Z",
      "stale": true
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

sequenceIdstringrequired

sequenceNamestringrequired

stepKeystringrequired

profileIdstringrequired

profileEmailstringrequired

profileNamestringrequired

subjectstringrequired

textstringrequired

editedbooleanrequired

queuedAtstringrequired

stalebooleanrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/mailboxes/{id}/resume

5XX Default Response

Same as 4XX · POST /v1/outbound/mailboxes/{id}/resume

GEThttps://hermeticor.com/v1/outbound/message-reviews/count

Parameters

staleAfterHoursintegerquery

= 48

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/outbound/message-reviews/count" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "pending": 0,
  "stale": 0
}

Schema

pendingintegerrequired

staleintegerrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/mailboxes/{id}/resume

5XX Default Response

Same as 4XX · POST /v1/outbound/mailboxes/{id}/resume

POSThttps://hermeticor.com/v1/outbound/message-reviews/decide

Approve or reject many waiting messages (ids, or a whole sequence)

Request body

application/json

idsstring[]

sequenceIdstring

actionstringrequired

approve | reject

{
  "ids": [
    "string"
  ],
  "sequenceId": "string",
  "action": "approve"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/message-reviews/decide" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["string"],"sequenceId":"string","action":"approve"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "decided": 0,
  "failed": 0,
  "more": true
}

Schema

decidedintegerrequired

failedintegerrequired

morebooleanrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/mailboxes/{id}/resume

5XX Default Response

Same as 4XX · POST /v1/outbound/mailboxes/{id}/resume

POSThttps://hermeticor.com/v1/outbound/message-reviews/{id}/decide

Approve (optionally edited) or reject one prospect’s message; approving sends through the normal path, consent rechecked

Parameters

idstringpathrequired

Request body

application/json

actionstringrequired

approve | reject

subjectstring

bodystring

{
  "action": "approve",
  "subject": "string",
  "body": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/message-reviews/{id}/decide" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"action":"approve","subject":"string","body":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/outbound/mailboxes/{id}/resume

4XX Default Response

Same as 4XX · POST /v1/outbound/mailboxes/{id}/resume

5XX Default Response

Same as 4XX · POST /v1/outbound/mailboxes/{id}/resume

GEThttps://hermeticor.com/v1/conversations

Replies to marketing campaigns

Parameters

limitintegerquery

= 50

cursorstringquery

categorystringquery

connectionIdstringquery

assigneeUserIdstringquery

sequenceIdstringquery

unreadbooleanquery

labelstringquery

leadStatusstringquery

includeSnoozedbooleanquery

= false

campaignIdstringquery

importantbooleanquery

remindersbooleanquery

unmatchedbooleanquery

ignoredbooleanquery

archivedbooleanquery

snoozedbooleanquery

listIdstringquery

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/conversations" \
  -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

Same as 4XX · POST /v1/outbound/mailboxes/{id}/resume

5XX Default Response

Same as 4XX · POST /v1/outbound/mailboxes/{id}/resume

Next part

Updated Nov 8, 2026

Was this page helpful?