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

Parameters

idstringpathrequired

Code samples

cURL

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

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

DELETEhttps://hermeticor.com/v1/outbound/inbox/{id}

Erase a received message's content (subject, text, headers, stored HTML). An empty marker stays so it is not imported again and counters stay right.

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/outbound/inbox/{id}" \
  -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 · GET /v1/outbound/inbox/{id}

5XX Default Response

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

GEThttps://hermeticor.com/v1/outbound/inbox/{id}/thread

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

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

5XX Default Response

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

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

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/outbound/inbox/{id}

4XX Default Response

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

5XX Default Response

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

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

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/outbound/inbox/{id}

4XX Default Response

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

5XX Default Response

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

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

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/outbound/inbox/{id}

4XX Default Response

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

5XX Default Response

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

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

Parameters

idstringpathrequired

Request body

application/json

assigneeUserIdstringrequired

{
  "assigneeUserId": "string"
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/outbound/inbox/{id}

4XX Default Response

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

5XX Default Response

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

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

Parameters

idstringpathrequired

Request body

application/json

labelsstring[]required

{
  "labels": [
    "string"
  ]
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/outbound/inbox/{id}

4XX Default Response

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

5XX Default Response

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

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

Parameters

idstringpathrequired

Request body

application/json

untilstring

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

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/outbound/inbox/{id}

4XX Default Response

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

5XX Default Response

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

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

Parameters

idstringpathrequired

Request body

application/json

categorystringrequired

{
  "category": "positive"
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java