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/analytics/pipeline

Pipeline value per sequence: interested and meeting-booked prospects (open), won, and the deal values typed on 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/analytics/pipeline" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "sequenceId": "string",
      "interested": 0,
      "meetings": 0,
      "won": 0,
      "lost": 0,
      "openCents": 0,
      "wonCents": 0,
      "unvalued": 0
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

sequenceIdstringrequired

interestedintegerrequired

meetingsintegerrequired

wonintegerrequired

lostintegerrequired

openCentsintegerrequired

wonCentsintegerrequired

unvaluedintegerrequired

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/analytics/pipeline

GEThttps://hermeticor.com/v1/outbound/ai-key

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "configured": true,
  "last4": "string",
  "provider": "string",
  "verified": true
}

Schema

configuredbooleanrequired

last4stringrequired

providerstringrequired

verifiedboolean

PUT only: Anthropic accepted the key (false = Anthropic could not be reached, checked on first use)

4XX Default Response

Same as 4XX · GET /v1/outbound/analytics/pipeline

5XX Default Response

Same as 4XX · GET /v1/outbound/analytics/pipeline

PUThttps://hermeticor.com/v1/outbound/ai-key

Save your own Anthropic API key (sealed; never returned). The key is checked with a free Anthropic call first: a rejected key is refused, an unreachable Anthropic saves it as verified: false

Request body

application/json

apiKeystringrequired

{
  "apiKey": "string"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/outbound/ai-key" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"apiKey":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/outbound/ai-key

4XX Default Response

Same as 4XX · GET /v1/outbound/analytics/pipeline

5XX Default Response

Same as 4XX · GET /v1/outbound/analytics/pipeline

DELETEhttps://hermeticor.com/v1/outbound/ai-key

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/outbound/ai-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/analytics/pipeline

5XX Default Response

Same as 4XX · GET /v1/outbound/analytics/pipeline

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

Write one short AI snippet per lead from its custom fields; poll the job, review, then POST /apply to save it to the field. Drafts only: nothing is sent

Request body

application/json

profileIdsstring[]required

fieldstringrequired

promptstringrequired

researchFieldstring

{
  "profileIds": [
    "string"
  ],
  "field": "string",
  "prompt": "string",
  "researchField": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/personalize" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"profileIds":["string"],"field":"string","prompt":"string","researchField":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

202 Default Response

Example

{
  "id": "string",
  "status": "queued",
  "total": 0,
  "processed": 0,
  "error": "string",
  "field": "string",
  "items": [
    {
      "profileId": "string",
      "text": "string",
      "error": "string"
    }
  ]
}

Schema

idstringrequired

statusstringrequired

queued | running | done | failed

totalintegerrequired

processedintegerrequired

errorstringrequired

fieldstringrequired

itemsItemsItem134[]required

Show child parameters

profileIdstringrequired

textstringrequired

errorstringrequired

4XX Default Response

Same as 4XX · GET /v1/outbound/analytics/pipeline

5XX Default Response

Same as 4XX · GET /v1/outbound/analytics/pipeline

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

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 202 · POST /v1/outbound/personalize

4XX Default Response

Same as 4XX · GET /v1/outbound/analytics/pipeline

5XX Default Response

Same as 4XX · GET /v1/outbound/analytics/pipeline

POSThttps://hermeticor.com/v1/outbound/personalize/{id}/apply

Save the reviewed snippets (all, or only the given leads) to the custom field they were written for

Parameters

idstringpathrequired

Request body

application/json

profileIdsstring[]

{
  "profileIds": [
    "string"
  ]
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "applied": 0,
  "skipped": 0
}

Schema

appliedintegerrequired

skippedintegerrequired

4XX Default Response

Same as 4XX · GET /v1/outbound/analytics/pipeline

5XX Default Response

Same as 4XX · GET /v1/outbound/analytics/pipeline

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

One feed of sends, replies, opens, clicks, bounces and finished calls or tasks across sequences, newest first

Parameters

limitintegerquery

= 50

beforestringquery

sequenceIdstringquery

profileIdstringquery

kindstringquery

Comma separated: sent, delivered, opened, clicked, replied, bounced, task:call, task:linkedin...

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "at": "2024-01-01T00:00:00Z",
      "source": "message",
      "kind": "string",
      "profileId": "string",
      "sequenceId": "string",
      "stepKey": "string",
      "channel": "string",
      "detail": "string"
    }
  ],
  "nextBefore": "2024-01-01T00:00:00Z"
}

Schema

itemsobject[]required

Show child parameters

atstringrequired

sourcestringrequired

message | task

kindstringrequired

profileIdstringrequired

sequenceIdstringrequired

stepKeystringrequired

channelstringrequired

detailstringrequired

nextBeforestringrequired

4XX Default Response

Same as 4XX · GET /v1/outbound/analytics/pipeline

5XX Default Response

Same as 4XX · GET /v1/outbound/analytics/pipeline

GEThttps://hermeticor.com/v1/outbound/sequences/{id}/statistics

Per prospect: messages sent, opened, clicked, replied and bounced

Parameters

limitintegerquery

= 100

afterstringquery

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "profileId": "string",
      "email": "string",
      "sent": 0,
      "opened": 0,
      "clicked": 0,
      "replied": 0,
      "bounced": 0,
      "lastActivityAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextAfter": "string"
}

Schema

itemsobject[]required

Show child parameters

profileIdstringrequired

emailstringrequired

sentnumberrequired

openednumberrequired

clickednumberrequired

repliednumberrequired

bouncednumberrequired

lastActivityAtstringrequired

nextAfterstringrequired

4XX Default Response

Same as 4XX · GET /v1/outbound/analytics/pipeline

5XX Default Response

Same as 4XX · GET /v1/outbound/analytics/pipeline

Next part

Updated Nov 8, 2026

Was this page helpful?