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

Tie an unmatched reply to a prospect

Parameters

idstringpathrequired

Request body

application/json

profileIdstringrequired

{
  "profileId": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/inbox/{id}/associate" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"profileId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "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"
  }
}

Schema

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

Show child parameters

namestring

emailstringrequired

machineCategorystringrequired

importantboolean

ignoredboolean

remindAtstring

latencySecinteger

profileobjectrequired

Show child parameters

idstringrequired

namestringrequired

emailstringrequired

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

POSThttps://hermeticor.com/v1/outbound/inbox/{id}/push-to-sequence

Move the reply's lead into another sequence

Parameters

idstringpathrequired

Request body

application/json

sequenceIdstringrequired

{
  "sequenceId": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/inbox/{id}/push-to-sequence" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sequenceId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "enrolled": 0,
  "skipped": [
    {
      "profileId": "string",
      "reason": "string"
    }
  ],
  "warnings": [
    {
      "profileId": "string",
      "warning": "string"
    }
  ]
}

Schema

enrolledintegerrequired

skippedSkippedItem[]required

Show child parameters

profileIdstringrequired

reasonstringrequired

warningsWarningsItem[]required

Show child parameters

profileIdstringrequired

warningstringrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/inbox/{id}/associate

5XX Default Response

Same as 4XX · POST /v1/outbound/inbox/{id}/associate

POSThttps://hermeticor.com/v1/outbound/meetings/{id}/complete

Parameters

idstringpathrequired

Request body

application/json

outcomestring

held | no_show | rescheduled = held

notesstring

{
  "outcome": "held",
  "notes": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/meetings/{id}/complete" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"outcome":"held","notes":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "profileId": "string",
  "completedAt": "2024-01-01T00:00:00Z",
  "outcome": "string"
}

Schema

idstringrequired

profileIdstringrequired

completedAtstringrequired

outcomestringrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/inbox/{id}/associate

5XX Default Response

Same as 4XX · POST /v1/outbound/inbox/{id}/associate

POSThttps://hermeticor.com/v1/outbound/inbox/{id}/forward

Forward a reply to another address (optionally scheduled)

Parameters

idstringpathrequired

Request body

application/json

tostringrequired

notestring

connectionIdstring

scheduledForstring

{
  "to": "string",
  "note": "string",
  "connectionId": "string",
  "scheduledFor": "2024-01-01T00:00:00Z"
}

Code samples

cURL

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

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 · POST /v1/outbound/inbox/{id}/associate

5XX Default Response

Same as 4XX · POST /v1/outbound/inbox/{id}/associate

GEThttps://hermeticor.com/v1/outbound/inbox-mail/sent

Replies and forwards sent from the inbox

Parameters

limitintegerquery

= 50

cursorstringquery

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "kind": "reply",
      "profileId": "string",
      "to": "string",
      "subject": "string",
      "status": "string",
      "connectionId": "string",
      "scheduledFor": "2024-01-01T00:00:00Z",
      "sentAt": "2024-01-01T00:00:00Z",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem133[]required

Show child parameters

idstringrequired

kindstringrequired

reply | forward | one_off

profileIdstringrequired

tostringrequired

subjectstringrequired

statusstringrequired

connectionIdstringrequired

scheduledForstringrequired

sentAtstringrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/inbox/{id}/associate

5XX Default Response

Same as 4XX · POST /v1/outbound/inbox/{id}/associate

GEThttps://hermeticor.com/v1/outbound/inbox-mail/scheduled

Replies and forwards waiting for their send time

Parameters

limitintegerquery

= 50

cursorstringquery

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/outbound/inbox-mail/sent

4XX Default Response

Same as 4XX · POST /v1/outbound/inbox/{id}/associate

5XX Default Response

Same as 4XX · POST /v1/outbound/inbox/{id}/associate

POSThttps://hermeticor.com/v1/outbound/inbox-mail/{id}/cancel

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · POST /v1/outbound/inbox/{id}/associate

5XX Default Response

Same as 4XX · POST /v1/outbound/inbox/{id}/associate

POSThttps://hermeticor.com/v1/outbound/inbox-mail/{id}/reschedule

Parameters

idstringpathrequired

Request body

application/json

atstringrequired

{
  "at": "2024-01-01T00:00:00Z"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/inbox-mail/{id}/reschedule" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"at":"2024-01-01T00:00:00Z"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "scheduledFor": "string"
}

Schema

idstringrequired

scheduledForstringrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/inbox/{id}/associate

5XX Default Response

Same as 4XX · POST /v1/outbound/inbox/{id}/associate

Next part

Updated Nov 8, 2026

Was this page helpful?