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>
POSThttps://hermeticor.com/v1/outbound/tasks/search

Search tasks with a nested and / or / not filter tree

Request body

application/json
filterschema0
limitinteger
= 50
cursorstring
{
  "filter": {},
  "limit": 50,
  "cursor": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/outbound/tasks/search" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"filter":{},"limit":50,"cursor":"string"}'
TypeScript
Python
Go
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
call | linkedin_visit | linkedin_connect | linkedin_message | sms | whatsapp | manual_email | reply_received | custom
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
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · POST /v1/outbound/tasks/search

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

Parameters

idstringpathrequired

Request body

application/json
assigneeUserIdstringrequired
{
  "assigneeUserId": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/outbound/tasks/{id}/assign" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"assigneeUserId":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 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
call | linkedin_visit | linkedin_connect | linkedin_message | sms | whatsapp | manual_email | reply_received | custom
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/tasks/search

5XX Default Response

Same as 4XX · POST /v1/outbound/tasks/search

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

Parameters

idstringpathrequired

Request body

application/json
notesstring
outcomestring
durationSecinteger
recordingUrlstring
externalIdstring
{
  "notes": "string",
  "outcome": "string",
  "durationSec": 0,
  "recordingUrl": "string",
  "externalId": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/outbound/tasks/{id}/complete" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"notes":"string","outcome":"string","durationSec":0,"recordingUrl":"string","externalId":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · POST /v1/outbound/tasks/{id}/assign

4XX Default Response

Same as 4XX · POST /v1/outbound/tasks/search

5XX Default Response

Same as 4XX · POST /v1/outbound/tasks/search

POSThttps://hermeticor.com/v1/outbound/tasks/{id}/skip

Parameters

idstringpathrequired

Request body

application/json
notesstring
outcomestring
durationSecinteger
recordingUrlstring
externalIdstring
{
  "notes": "string",
  "outcome": "string",
  "durationSec": 0,
  "recordingUrl": "string",
  "externalId": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/outbound/tasks/{id}/skip" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"notes":"string","outcome":"string","durationSec":0,"recordingUrl":"string","externalId":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · POST /v1/outbound/tasks/{id}/assign

4XX Default Response

Same as 4XX · POST /v1/outbound/tasks/search

5XX Default Response

Same as 4XX · POST /v1/outbound/tasks/search

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

Parameters

idstringpathrequired

Request body

application/json
untilstringrequired
{
  "until": "2024-01-01T00:00:00Z"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/outbound/tasks/{id}/snooze" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"until":"2024-01-01T00:00:00Z"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · POST /v1/outbound/tasks/{id}/assign

4XX Default Response

Same as 4XX · POST /v1/outbound/tasks/search

5XX Default Response

Same as 4XX · POST /v1/outbound/tasks/search

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

Sender pools (readable with outbound:read, for sequence mailbox pickers)

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "name": "string",
      "channel": "email",
      "strategy": "round_robin",
      "members": [
        {
          "connectionId": "string",
          "senderIdentityId": null,
          "weight": 1
        }
      ],
      "matchProvider": true
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem22[]required
Show child parameters
idstringrequired
namestringrequired
channelstringrequired
email | sms | whatsapp | push | postcard
strategystringrequired
round_robin | weighted | least_used | sticky_per_recipient
membersMembersItem[]required
Show child parameters
connectionIdstringrequired
senderIdentityIdstringrequired
= null
weightintegerrequired
= 1
matchProviderbooleanrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · POST /v1/outbound/tasks/search

5XX Default Response

Same as 4XX · POST /v1/outbound/tasks/search

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

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "profileId": "string",
      "source": "calendar_link",
      "at": "2024-01-01T00:00:00Z",
      "ref": "string",
      "sequenceId": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "completedAt": "2024-01-01T00:00:00Z",
      "outcome": "string"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsPostV1OutboundMeetingsResponse[]required
Show child parameters
idstringrequired
profileIdstringrequired
sourcestringrequired
calendar_link | reply_detected | manual
atstringrequired
refstringrequired
sequenceIdstringrequired
createdAtstringrequired
completedAtstring
outcomestring
nextCursorstringrequired
4XX Default Response

Same as 4XX · POST /v1/outbound/tasks/search

5XX Default Response

Same as 4XX · POST /v1/outbound/tasks/search

Updated