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/prospects/{profileId}/resume

Parameters

profileIdstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/prospects/{profileId}/resume" \
  -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/prospects/{profileId}/resume

POSThttps://hermeticor.com/v1/outbound/prospects/{profileId}/stop-sequences

End every live sequence of a person (lifecycle change, CRM stage, manual)

Parameters

profileIdstringpathrequired

Request body

application/json

reasonstring

= manual

{
  "reason": "manual"
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/outbound/prospects/{profileId}/resume

4XX Default Response

Same as 4XX · POST /v1/outbound/prospects/{profileId}/resume

5XX Default Response

Same as 4XX · POST /v1/outbound/prospects/{profileId}/resume

GEThttps://hermeticor.com/v1/outbound/sequences/{id}/sending-status

Why is this sequence not sending

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "sequenceId": "string",
  "status": "string",
  "sending": true,
  "enrollments": {},
  "window": {
    "openNow": true,
    "timezone": "string",
    "nextOpenAt": "2024-01-01T00:00:00Z"
  },
  "mailboxes": [
    {
      "connectionId": "string",
      "name": "string",
      "status": "string",
      "health": "string",
      "sentToday": 0,
      "dailyCap": 0,
      "sequenceDailyLimit": 0,
      "pausedForSequence": true,
      "atCap": true
    }
  ],
  "dailyNew": {
    "limit": 0,
    "enrolledToday": 0
  },
  "reasons": [
    {
      "code": "string",
      "severity": "blocker",
      "message": "string"
    }
  ]
}

Schema

sequenceIdstringrequired

statusstringrequired

sendingbooleanrequired

enrollmentsobjectrequired

windowobjectrequired

Show child parameters

openNowbooleanrequired

timezonestringrequired

nextOpenAtstringrequired

mailboxesobject[]required

Show child parameters

connectionIdstringrequired

namestringrequired

statusstringrequired

healthstringrequired

sentTodayintegerrequired

dailyCapintegerrequired

sequenceDailyLimitintegerrequired

pausedForSequencebooleanrequired

atCapbooleanrequired

dailyNewobjectrequired

Show child parameters

limitintegerrequired

enrolledTodayintegerrequired

reasonsReasonsItem[]required

Show child parameters

codestringrequired

severitystringrequired

blocker | warning | info

messagestringrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/prospects/{profileId}/resume

5XX Default Response

Same as 4XX · POST /v1/outbound/prospects/{profileId}/resume

GEThttps://hermeticor.com/v1/outbound/sequences/{id}/prospects/{profileId}/diagnostics

Why is this prospect not getting the next step

Parameters

idstringpathrequired

profileIdstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "enrollmentId": "string",
  "profileId": "string",
  "state": "string",
  "currentNodeId": "string",
  "nextRunAt": "2024-01-01T00:00:00Z",
  "mailboxConnectionId": "string",
  "eligible": true,
  "reasons": [
    {
      "code": "string",
      "severity": "blocker",
      "message": "string"
    }
  ],
  "recent": [
    {
      "at": "2024-01-01T00:00:00Z",
      "nodeId": "string",
      "kind": "string",
      "note": "string"
    }
  ]
}

Schema

enrollmentIdstringrequired

profileIdstringrequired

statestringrequired

currentNodeIdstringrequired

nextRunAtstringrequired

mailboxConnectionIdstringrequired

eligiblebooleanrequired

reasonsReasonsItem[]required

Show child parameters

codestringrequired

severitystringrequired

blocker | warning | info

messagestringrequired

recentobject[]required

Show child parameters

atstringrequired

nodeIdstringrequired

kindstringrequired

notestringrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/prospects/{profileId}/resume

5XX Default Response

Same as 4XX · POST /v1/outbound/prospects/{profileId}/resume

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

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/schedules" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "name": "string",
      "weekdays": [
        1,
        2,
        3,
        4,
        5
      ],
      "startMin": 540,
      "endMin": 1020,
      "timezoneSource": "prospect",
      "timezone": "UTC",
      "id": "string",
      "sequences": 0,
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem128[]required

Show child parameters

namestringrequired

weekdaysinteger[]required

= [1,2,3,4,5]

startMinintegerrequired

= 540

endMinintegerrequired

= 1020

timezoneSourcestringrequired

prospect | sequence = prospect

timezonestringrequired

= UTC

idstringrequired

sequencesintegerrequired

updatedAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/prospects/{profileId}/resume

5XX Default Response

Same as 4XX · POST /v1/outbound/prospects/{profileId}/resume

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

Request body

application/json

namestringrequired

weekdaysinteger[]

= [1,2,3,4,5]

startMininteger

= 540

endMininteger

= 1020

timezoneSourcestring

prospect | sequence = prospect

timezonestring

= UTC

{
  "name": "string",
  "weekdays": [
    1,
    2,
    3,
    4,
    5
  ],
  "startMin": 540,
  "endMin": 1020,
  "timezoneSource": "prospect",
  "timezone": "UTC"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/schedules" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","weekdays":[1,2,3,4,5],"startMin":540,"endMin":1020,"timezoneSource":"prospect","timezone":"UTC"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "name": "string",
  "weekdays": [
    1,
    2,
    3,
    4,
    5
  ],
  "startMin": 540,
  "endMin": 1020,
  "timezoneSource": "prospect",
  "timezone": "UTC",
  "id": "string",
  "sequences": 0,
  "updatedAt": "2024-01-01T00:00:00Z"
}

Schema

namestringrequired

weekdaysinteger[]required

= [1,2,3,4,5]

startMinintegerrequired

= 540

endMinintegerrequired

= 1020

timezoneSourcestringrequired

prospect | sequence = prospect

timezonestringrequired

= UTC

idstringrequired

sequencesintegerrequired

updatedAtstringrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/prospects/{profileId}/resume

5XX Default Response

Same as 4XX · POST /v1/outbound/prospects/{profileId}/resume

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

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/outbound/schedules

4XX Default Response

Same as 4XX · POST /v1/outbound/prospects/{profileId}/resume

5XX Default Response

Same as 4XX · POST /v1/outbound/prospects/{profileId}/resume

PUThttps://hermeticor.com/v1/outbound/schedules/{id}

Edit a schedule (re-compiles the sequences that use it)

Parameters

idstringpathrequired

Request body

application/json

namestringrequired

weekdaysinteger[]

= [1,2,3,4,5]

startMininteger

= 540

endMininteger

= 1020

timezoneSourcestring

prospect | sequence = prospect

timezonestring

= UTC

{
  "name": "string",
  "weekdays": [
    1,
    2,
    3,
    4,
    5
  ],
  "startMin": 540,
  "endMin": 1020,
  "timezoneSource": "prospect",
  "timezone": "UTC"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/outbound/schedules/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","weekdays":[1,2,3,4,5],"startMin":540,"endMin":1020,"timezoneSource":"prospect","timezone":"UTC"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/outbound/schedules

4XX Default Response

Same as 4XX · POST /v1/outbound/prospects/{profileId}/resume

5XX Default Response

Same as 4XX · POST /v1/outbound/prospects/{profileId}/resume

Next part

Updated Nov 8, 2026

Was this page helpful?