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/outbound/subsequences

Sequences started by a reply rule or reply label, with what starts them

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "name": "string",
      "status": "string",
      "startedBy": [
        {
          "kind": "sequence",
          "id": "string",
          "name": "string",
          "category": "string"
        }
      ]
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem179[]required
Show child parameters
idstringrequired
namestringrequired
statusstringrequired
startedByStartedByItem[]required
Show child parameters
kindstringrequired
sequence | reply_label
idstringrequired
namestringrequired
categorystringrequired
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/subsequences

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

Parameters

idstringpathrequired

Code samples

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

Responses

200 Default Response
Example
{
  "id": "string",
  "name": "string",
  "status": "string",
  "startedBy": [
    {
      "kind": "sequence",
      "id": "string",
      "name": "string",
      "category": "string"
    }
  ]
}
Schema
idstringrequired
namestringrequired
statusstringrequired
startedByStartedByItem[]required
Show child parameters
kindstringrequired
sequence | reply_label
idstringrequired
namestringrequired
categorystringrequired
4XX Default Response

Same as 4XX · GET /v1/outbound/subsequences

5XX Default Response

Same as 4XX · GET /v1/outbound/subsequences

PATCHhttps://hermeticor.com/v1/workflows/{id}/enrollments/{enrollmentId}/variables

Set values (usable as {{ vars.key }}) for this one prospect in this one sequence

Parameters

idstringpathrequired
enrollmentIdstringpathrequired

Request body

application/json
variablesobjectrequired
{
  "variables": {}
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/workflows/{id}/enrollments/{enrollmentId}/variables" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"variables":{}}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response

Same as 4XX · GET /v1/outbound/subsequences

5XX Default Response

Same as 4XX · GET /v1/outbound/subsequences

GEThttps://hermeticor.com/v1/outbound/reply-statuses

The statuses a reply can have: the built-in categories and your own labels

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "key": "string",
      "label": "string",
      "builtin": true
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
keystringrequired
labelstringrequired
builtinbooleanrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/outbound/subsequences

5XX Default Response

Same as 4XX · GET /v1/outbound/subsequences

POSThttps://hermeticor.com/v1/outbound/sequences/{id}/enroll-accounts

ABM: enroll the contacts of these companies, grouped per account (per-account cap and stop rule from the sequence settings)

Parameters

idstringpathrequired

Request body

application/json
companyIdsstring[]required
ownerUserIdstring
{
  "companyIds": [
    "string"
  ],
  "ownerUserId": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/outbound/sequences/{id}/enroll-accounts" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"companyIds":["string"],"ownerUserId":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "enrolled": 0,
  "skipped": [
    {
      "profileId": "string",
      "reason": "string"
    }
  ],
  "warnings": [
    {
      "profileId": "string",
      "warning": "string"
    }
  ],
  "accounts": [
    {
      "accountId": "string",
      "enrolled": 0,
      "capped": 0
    }
  ]
}
Schema
enrolledintegerrequired
skippedSkippedItem[]required
Show child parameters
profileIdstringrequired
reasonstringrequired
warningsWarningsItem[]required
Show child parameters
profileIdstringrequired
warningstringrequired
accountsobject[]required
Show child parameters
accountIdstringrequired
enrolledintegerrequired
cappedintegerrequired
4XX Default Response

Same as 4XX · GET /v1/outbound/subsequences

5XX Default Response

Same as 4XX · GET /v1/outbound/subsequences

POSThttps://hermeticor.com/v1/outbound/sequences/{id}/export-leads

CSV of the sequence's leads with their fields, variables and per-lead stats, built in the background; optional email when ready

Parameters

idstringpathrequired

Request body

application/json
notifyEmailstring
{
  "notifyEmail": "string"
}

Code samples

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

Responses

202 Default Response
Example
{
  "id": "string",
  "kind": "bulk",
  "op": "string",
  "status": "queued",
  "progress": {
    "total": 0,
    "processed": 0,
    "failed": 0
  },
  "error": "string",
  "downloadUrl": "string",
  "failures": [
    {
      "profileId": "string",
      "message": "string"
    }
  ],
  "createdAt": "2024-01-01T00:00:00Z",
  "finishedAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
kindstringrequired
bulk | export
opstringrequired
statusstringrequired
queued | running | completed | failed
progressobjectrequired
Show child parameters
totalintegerrequired
processedintegerrequired
failedintegerrequired
errorstringrequired
downloadUrlstring
failuresFailuresItem[]
Show child parameters
profileIdstringrequired
messagestringrequired
createdAtstringrequired
finishedAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/outbound/subsequences

5XX Default Response

Same as 4XX · GET /v1/outbound/subsequences

GEThttps://hermeticor.com/v1/outbound/task-types

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "key": "string",
      "label": "string",
      "color": "#6b7280",
      "outcomes": [],
      "position": 0,
      "id": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem216[]required
Show child parameters
keystringrequired
labelstringrequired
colorstringrequired
= #6b7280
outcomesstring[]required
= []
positionintegerrequired
= 0
idstringrequired
createdAtstringrequired
updatedAtstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/outbound/subsequences

5XX Default Response

Same as 4XX · GET /v1/outbound/subsequences

POSThttps://hermeticor.com/v1/outbound/task-types

Request body

application/json
keystringrequired
labelstringrequired
colorstring
= #6b7280
outcomesstring[]
= []
positioninteger
= 0
{
  "key": "string",
  "label": "string",
  "color": "#6b7280",
  "outcomes": [],
  "position": 0
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/outbound/task-types" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"key":"string","label":"string","color":"#6b7280","outcomes":[],"position":0}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "key": "string",
  "label": "string",
  "color": "#6b7280",
  "outcomes": [],
  "position": 0,
  "id": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}
Schema
keystringrequired
labelstringrequired
colorstringrequired
= #6b7280
outcomesstring[]required
= []
positionintegerrequired
= 0
idstringrequired
createdAtstringrequired
updatedAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/outbound/subsequences

5XX Default Response

Same as 4XX · GET /v1/outbound/subsequences

Updated