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/call-dispositions

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/call-dispositions" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "key": "string",
      "label": "string",
      "connected": false,
      "position": 0,
      "id": "string",
      "builtin": true
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem130[]required

Show child parameters

keystringrequired

labelstringrequired

connectedbooleanrequired

= false

positionintegerrequired

= 0

idstringrequired

builtinbooleanrequired

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/call-dispositions

PUThttps://hermeticor.com/v1/outbound/call-dispositions

Request body

application/json

keystringrequired

labelstringrequired

connectedboolean

= false

positioninteger

= 0

{
  "key": "string",
  "label": "string",
  "connected": false,
  "position": 0
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/outbound/call-dispositions" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"key":"string","label":"string","connected":false,"position":0}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "key": "string",
  "label": "string",
  "connected": false,
  "position": 0,
  "id": "string",
  "builtin": true
}

Schema

keystringrequired

labelstringrequired

connectedbooleanrequired

= false

positionintegerrequired

= 0

idstringrequired

builtinbooleanrequired

4XX Default Response

Same as 4XX · GET /v1/outbound/call-dispositions

5XX Default Response

Same as 4XX · GET /v1/outbound/call-dispositions

DELETEhttps://hermeticor.com/v1/outbound/call-dispositions/{key}

Parameters

keystringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/outbound/call-dispositions/{key}" \
  -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/call-dispositions

5XX Default Response

Same as 4XX · GET /v1/outbound/call-dispositions

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

Log a finished call (outcome, duration, recording link)

Request body

application/json

profileIdstringrequired

outcomestringrequired

durationSecinteger

recordingUrlstring

notesstring

transcriptstring

externalIdstring

atstring

assigneeUserIdstring

{
  "profileId": "string",
  "outcome": "string",
  "durationSec": 0,
  "recordingUrl": "string",
  "notes": "string",
  "transcript": "string",
  "externalId": "string",
  "at": "2024-01-01T00:00:00Z",
  "assigneeUserId": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/calls" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"profileId":"string","outcome":"string","durationSec":0,"recordingUrl":"string","notes":"string","transcript":"string","externalId":"string","at":"2024-01-01T00:00:00Z","assigneeUserId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "kind": "call",
  "profileId": "string",
  "enrollmentId": "string",
  "nodeId": "string",
  "assigneeUserId": "string",
  "title": "string",
  "notes": "string",
  "outcome": "string",
  "durationSec": 0,
  "recordingUrl": "string",
  "transcript": "string",
  "externalId": "string",
  "dueAt": "2024-01-01T00:00:00Z",
  "status": "open",
  "completedAt": "2024-01-01T00:00:00Z",
  "typeId": "string",
  "companyId": "string",
  "contactIds": [
    "string"
  ],
  "plannedMin": 0,
  "remindBeforeMin": 0,
  "voicemailClipId": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z",
  "profile": {
    "id": "string",
    "name": "string",
    "email": "string"
  }
}

Schema

idstringrequired

kindstringrequired

profileIdstringrequired

enrollmentIdstringrequired

nodeIdstringrequired

assigneeUserIdstringrequired

titlestringrequired

notesstringrequired

outcomestringrequired

durationSecinteger

recordingUrlstring

transcriptstring

externalIdstring

dueAtstringrequired

statusstringrequired

open | done | skipped

completedAtstringrequired

typeIdstring

companyIdstring

contactIdsstring[]

plannedMininteger

remindBeforeMininteger

voicemailClipIdstring

createdAtstringrequired

updatedAtstringrequired

profileobjectrequired

Show child parameters

idstringrequired

namestringrequired

emailstringrequired

4XX Default Response

Same as 4XX · GET /v1/outbound/call-dispositions

5XX Default Response

Same as 4XX · GET /v1/outbound/call-dispositions

GEThttps://hermeticor.com/v1/outbound/calls/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/outbound/calls

4XX Default Response

Same as 4XX · GET /v1/outbound/call-dispositions

5XX Default Response

Same as 4XX · GET /v1/outbound/call-dispositions

PATCHhttps://hermeticor.com/v1/outbound/calls/{id}

Parameters

idstringpathrequired

Request body

application/json

outcomestring

durationSecinteger

recordingUrlstring

notesstring

transcriptstring

externalIdstring

atstring

assigneeUserIdstring

{
  "outcome": "string",
  "durationSec": 0,
  "recordingUrl": "string",
  "notes": "string",
  "transcript": "string",
  "externalId": "string",
  "at": "2024-01-01T00:00:00Z",
  "assigneeUserId": "string"
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/outbound/calls/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"outcome":"string","durationSec":0,"recordingUrl":"string","notes":"string","transcript":"string","externalId":"string","at":"2024-01-01T00:00:00Z","assigneeUserId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/outbound/calls

4XX Default Response

Same as 4XX · GET /v1/outbound/call-dispositions

5XX Default Response

Same as 4XX · GET /v1/outbound/call-dispositions

DELETEhttps://hermeticor.com/v1/outbound/calls/{id}/recording

Delete the recording link and transcript of a logged call (outcome, length and notes stay)

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/outbound/calls

4XX Default Response

Same as 4XX · GET /v1/outbound/call-dispositions

5XX Default Response

Same as 4XX · GET /v1/outbound/call-dispositions

GEThttps://hermeticor.com/v1/outbound/tasks/filters

Filter fields the task list accepts

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/tasks/filters" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "field": "string",
      "type": "string",
      "values": [
        "string"
      ]
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

fieldstringrequired

typestringrequired

valuesstring[]

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/outbound/call-dispositions

5XX Default Response

Same as 4XX · GET /v1/outbound/call-dispositions

GEThttps://hermeticor.com/v1/outbound/inbox/counts

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "unread": 0,
  "important": 0,
  "reminders": 0,
  "unmatched": 0
}

Schema

unreadintegerrequired

importantintegerrequired

remindersintegerrequired

unmatchedintegerrequired

4XX Default Response

Same as 4XX · GET /v1/outbound/call-dispositions

5XX Default Response

Same as 4XX · GET /v1/outbound/call-dispositions

Next part

Updated Nov 8, 2026

Was this page helpful?