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/sequences/{id}/prospects/{profileId}/interested

Mark the lead interested for this sequence (credits the sequence pipeline)

Parameters

idstringpathrequired

profileIdstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/sequences/{id}/prospects/{profileId}/interested" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "affected": 0,
  "skipped": []
}

Schema

affectedintegerrequired

skippedSkippedItem[]required

= []

Show child parameters

profileIdstringrequired

reasonstringrequired

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/sequences/{id}/prospects/{profileId}/interested

POSThttps://hermeticor.com/v1/outbound/sequences/{id}/prospects/{profileId}/not-interested

Mark the lead not interested for this sequence

Parameters

idstringpathrequired

profileIdstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/sequences/{id}/prospects/{profileId}/not-interested" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/outbound/sequences/{id}/prospects/{profileId}/interested

4XX Default Response

Same as 4XX · POST /v1/outbound/sequences/{id}/prospects/{profileId}/interested

5XX Default Response

Same as 4XX · POST /v1/outbound/sequences/{id}/prospects/{profileId}/interested

POSThttps://hermeticor.com/v1/outbound/sequences/{id}/prospects/{profileId}/skip

Skip a step for one lead (default: the next action it is about to take)

Parameters

idstringpathrequired

profileIdstringpathrequired

Request body

application/json

stepKeystring

{
  "stepKey": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/sequences/{id}/prospects/{profileId}/skip" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"stepKey":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/outbound/sequences/{id}/prospects/{profileId}/interested

4XX Default Response

Same as 4XX · POST /v1/outbound/sequences/{id}/prospects/{profileId}/interested

5XX Default Response

Same as 4XX · POST /v1/outbound/sequences/{id}/prospects/{profileId}/interested

POSThttps://hermeticor.com/v1/outbound/sequences/{id}/skip-step

Skip a step for everyone (or the listed leads) who has not passed it

Parameters

idstringpathrequired

Request body

application/json

stepKeystringrequired

profileIdsstring[]

{
  "stepKey": "string",
  "profileIds": [
    "string"
  ]
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/outbound/sequences/{id}/prospects/{profileId}/interested

4XX Default Response

Same as 4XX · POST /v1/outbound/sequences/{id}/prospects/{profileId}/interested

5XX Default Response

Same as 4XX · POST /v1/outbound/sequences/{id}/prospects/{profileId}/interested

PUThttps://hermeticor.com/v1/outbound/sequences/{id}/prospects/{profileId}/steps/{stepKey}/override

Replace one email step's copy for this lead only

Parameters

idstringpathrequired

profileIdstringpathrequired

stepKeystringpathrequired

Request body

application/json

subjectstring

textstringrequired

htmlstring

{
  "subject": "string",
  "text": "string",
  "html": "string"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/outbound/sequences/{id}/prospects/{profileId}/steps/{stepKey}/override" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"subject":"string","text":"string","html":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · POST /v1/outbound/sequences/{id}/prospects/{profileId}/interested

5XX Default Response

Same as 4XX · POST /v1/outbound/sequences/{id}/prospects/{profileId}/interested

DELETEhttps://hermeticor.com/v1/outbound/sequences/{id}/prospects/{profileId}/steps/{stepKey}/override

Parameters

idstringpathrequired

profileIdstringpathrequired

stepKeystringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/outbound/sequences/{id}/prospects/{profileId}/steps/{stepKey}/override" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PUT /v1/outbound/sequences/{id}/prospects/{profileId}/steps/{stepKey}/override

4XX Default Response

Same as 4XX · POST /v1/outbound/sequences/{id}/prospects/{profileId}/interested

5XX Default Response

Same as 4XX · POST /v1/outbound/sequences/{id}/prospects/{profileId}/interested

POSThttps://hermeticor.com/v1/outbound/sequences/{id}/prospects/{profileId}/move-mailbox

Parameters

idstringpathrequired

profileIdstringpathrequired

Request body

application/json

connectionIdstringrequired

{
  "connectionId": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/sequences/{id}/prospects/{profileId}/move-mailbox" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"connectionId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PUT /v1/outbound/sequences/{id}/prospects/{profileId}/steps/{stepKey}/override

4XX Default Response

Same as 4XX · POST /v1/outbound/sequences/{id}/prospects/{profileId}/interested

5XX Default Response

Same as 4XX · POST /v1/outbound/sequences/{id}/prospects/{profileId}/interested

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

Move prospects to another sequence: enrolled there first (all gates apply), then ended here

Parameters

idstringpathrequired

Request body

application/json

toSequenceIdstringrequired

profileIdsstring[]required

{
  "toSequenceId": "string",
  "profileIds": [
    "string"
  ]
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/outbound/sequences/{id}/prospects/{profileId}/interested

4XX Default Response

Same as 4XX · POST /v1/outbound/sequences/{id}/prospects/{profileId}/interested

5XX Default Response

Same as 4XX · POST /v1/outbound/sequences/{id}/prospects/{profileId}/interested

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

Prospects of a sequence with their state (filter by state or email; export-ready)

Parameters

statestringquery

emailstringquery

limitintegerquery

= 100

cursorstringquery

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "enrollmentId": "string",
      "profileId": "string",
      "email": "string",
      "state": "string",
      "currentNodeId": "string",
      "nextRunAt": "2024-01-01T00:00:00Z",
      "pausedReason": "string",
      "exitedReason": "string",
      "enteredAt": "2024-01-01T00:00:00Z",
      "stuckReason": "string",
      "overrides": [
        "string"
      ]
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

enrollmentIdstringrequired

profileIdstringrequired

emailstringrequired

statestringrequired

currentNodeIdstringrequired

nextRunAtstringrequired

pausedReasonstringrequired

exitedReasonstringrequired

enteredAtstringrequired

stuckReasonstringrequired

overridesstring[]required

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/sequences/{id}/prospects/{profileId}/interested

5XX Default Response

Same as 4XX · POST /v1/outbound/sequences/{id}/prospects/{profileId}/interested

POSThttps://hermeticor.com/v1/outbound/prospects/{profileId}/pause

Pause the person in every live sequence

Parameters

profileIdstringpathrequired

Request body

application/json

reasonstring

= manual

{
  "reason": "manual"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/prospects/{profileId}/pause" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"manual"}'

TypeScript

Python

PHP

Ruby

Java