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}/reply

Parameters

idstringpathrequired

Request body

application/json

textstringrequired

subjectstring

connectionIdstring

scheduledForstring

{
  "text": "string",
  "subject": "string",
  "connectionId": "string",
  "scheduledFor": "2024-01-01T00:00:00Z"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/inbox/{id}/reply" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"string","subject":"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

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}/reply

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

Parameters

idstringpathrequired

Request body

application/json

enrollSequenceIdstring

{
  "enrollSequenceId": "string"
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

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

Schema

profileIdstringrequired

enrollobjectrequired

Show child parameters

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}/reply

5XX Default Response

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

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

Parameters

limitintegerquery

= 50

cursorstringquery

assigneeUserIdstringquery

statusstringquery

open | done | skipped

bucketstringquery

overdue | today | upcoming

kindstringquery

profileIdstringquery

unassignedbooleanquery

dueBeforestringquery

dueAfterstringquery

outcomestringquery

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "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"
      }
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem85[]required

Show child parameters

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

nextCursorstringrequired

4XX Default Response

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

5XX Default Response

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

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

Request body

application/json

kindstring

profileIdstringrequired

titlestringrequired

notesstring

assigneeUserIdstring

dueAtstring

typeIdstring

companyIdstring

contactIdsstring[]

plannedMininteger

remindBeforeMininteger

{
  "kind": "custom",
  "profileId": "string",
  "title": "string",
  "notes": "string",
  "assigneeUserId": "string",
  "dueAt": "2024-01-01T00:00:00Z",
  "typeId": "string",
  "companyId": "string",
  "contactIds": [
    "string"
  ],
  "plannedMin": 0,
  "remindBeforeMin": 0
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/tasks" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"custom","profileId":"string","title":"string","notes":"string","assigneeUserId":"string","dueAt":"2024-01-01T00:00:00Z","typeId":"string","companyId":"string","contactIds":["string"],"plannedMin":0,"remindBeforeMin":0}'

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

5XX Default Response

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

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

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/outbound/tasks

4XX Default Response

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

5XX Default Response

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

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

Delete a task (skip keeps it as history)

Parameters

idstringpathrequired

Code samples

cURL

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

5XX Default Response

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

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

Edit an open task: title, notes, due date, kind, type, links and reminder

Parameters

idstringpathrequired

Request body

application/json

titlestring

notesstring

dueAtstring

kindstring

typeIdstring

companyIdstring

contactIdsstring[]

plannedMininteger

remindBeforeMininteger

{
  "title": "string",
  "notes": "string",
  "dueAt": "2024-01-01T00:00:00Z",
  "kind": "call",
  "typeId": "string",
  "companyId": "string",
  "contactIds": [
    "string"
  ],
  "plannedMin": 0,
  "remindBeforeMin": 0
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/outbound/tasks/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"string","notes":"string","dueAt":"2024-01-01T00:00:00Z","kind":"call","typeId":"string","companyId":"string","contactIds":["string"],"plannedMin":0,"remindBeforeMin":0}'

TypeScript

Python

PHP

Ruby

Java