outbound

Embed
Preview of the card
<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/conversations/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/conversations/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
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
positive | negative | neutral | ooo | auto_reply | bounce | unsubscribe | meeting | wrong_person
confidencenumberrequired
sourcestringrequired
rule | llm | manual
labelsstring[]required
snoozedUntilstringrequired
oooUntilstringrequired
referralobjectrequired
Show child parameters
namestring
emailstringrequired
machineCategorystringrequired
positive | negative | neutral | ooo | auto_reply | bounce | unsubscribe | meeting | wrong_person
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 · GET /v1/conversations/{id}

GEThttps://hermeticor.com/v1/conversations/{id}/messages

Parameters

idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/conversations/{id}/messages" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "profileId": "string",
  "items": [
    {
      "kind": "sent",
      "id": "string",
      "at": "2024-01-01T00:00:00Z",
      "subject": "string",
      "text": "string",
      "status": "string",
      "connectionId": "string",
      "stepKey": "string",
      "classification": "string"
    }
  ]
}
Schema
profileIdstringrequired
itemsItemsItem84[]required
Show child parameters
kindstringrequired
sent | received
idstringrequired
atstringrequired
subjectstringrequired
textstringrequired
statusstringrequired
connectionIdstringrequired
stepKeystringrequired
classificationstringrequired
4XX Default Response

Same as 4XX · GET /v1/conversations/{id}

5XX Default Response

Same as 4XX · GET /v1/conversations/{id}

GEThttps://hermeticor.com/v1/conversations/{id}/messages/{messageId}

Parameters

idstringpathrequired
messageIdstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/conversations/{id}/messages/{messageId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/conversations/{id}

4XX Default Response

Same as 4XX · GET /v1/conversations/{id}

5XX Default Response

Same as 4XX · GET /v1/conversations/{id}

GEThttps://hermeticor.com/v1/campaigns/{id}/replies

Replies to one campaign

Parameters

limitintegerquery
= 50
cursorstringquery
categorystringquery
positive | negative | neutral | ooo | auto_reply | bounce | unsubscribe | meeting | wrong_person
connectionIdstringquery
assigneeUserIdstringquery
sequenceIdstringquery
unreadbooleanquery
labelstringquery
leadStatusstringquery
new | contacted | replied | interested | meeting_booked | won | lost | not_interested | bounced | unsubscribed | do_not_contact
includeSnoozedbooleanquery
= false
campaignIdstringquery
importantbooleanquery
remindersbooleanquery
unmatchedbooleanquery
ignoredbooleanquery
archivedbooleanquery
snoozedbooleanquery
listIdstringquery
idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/campaigns/{id}/replies" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
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
positive | negative | neutral | ooo | auto_reply | bounce | unsubscribe | meeting | wrong_person
confidencenumberrequired
sourcestringrequired
rule | llm | manual
labelsstring[]required
snoozedUntilstringrequired
oooUntilstringrequired
referralobjectrequired
machineCategorystringrequired
positive | negative | neutral | ooo | auto_reply | bounce | unsubscribe | meeting | wrong_person
importantboolean
ignoredboolean
remindAtstring
latencySecinteger
profileobjectrequired
Show child parameters
idstringrequired
namestringrequired
emailstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/conversations/{id}

5XX Default Response

Same as 4XX · GET /v1/conversations/{id}

GEThttps://hermeticor.com/v1/outbound/inbox-views

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/inbox-views" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "name": "string",
      "filters": {
        "category": "positive",
        "connectionId": "string",
        "assigneeUserId": "string",
        "sequenceId": "string",
        "unread": true,
        "label": "string",
        "leadStatus": "new"
      },
      "ownerUserId": "string",
      "shared": true,
      "position": 0
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem125[]required
Show child parameters
idstringrequired
namestringrequired
filtersobjectrequired
Show child parameters
categorystring
positive | negative | neutral | ooo | auto_reply | bounce | unsubscribe | meeting | wrong_person
connectionIdstring
assigneeUserIdstring
sequenceIdstring
unreadboolean
labelstring
leadStatusstring
new | contacted | replied | interested | meeting_booked | won | lost | not_interested | bounced | unsubscribed | do_not_contact
ownerUserIdstringrequired
sharedbooleanrequired
positionintegerrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/conversations/{id}

5XX Default Response

Same as 4XX · GET /v1/conversations/{id}

Updated