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>

DELETEhttps://hermeticor.com/v1/outbound/sequences/{id}

Permanently delete a sequence (archive it first if it is live or paused)

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · DELETE /v1/outbound/sequences/{id}

PATCHhttps://hermeticor.com/v1/outbound/sequences/{id}

Parameters

idstringpathrequired

Request body

application/json

namestring

settingsobject

Show child parameters

stepsStepsItem[]

scheduleobject

Show child parameters

weekdaysinteger[]

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

startMininteger

= 540

endMininteger

= 1020

timezoneSourcestring

prospect | sequence = prospect

timezonestring

= UTC

mailboxobject

Show child parameters

poolIdstring

connectionIdstring

stickyboolean

= true

onUnavailablestring

pause | reassign = pause

dailyNewLimitinteger

followUpPercentinteger

plainTextOnlyboolean

trackOpensboolean

unsubscribeTextstring

spintaxModestring

random | sequential

variablesobject

blocklistobject

Show child parameters

emailsstring[]

domainsstring[]

= []

reviewBeforeSendboolean

reviewEachMessageboolean

stopobject

Show child parameters

onReplystring

human | any = human

onAutoReplystring

continue | pause = continue

onOoostring

pause_until_return | continue | stop = pause_until_return

onCompanyReplystring

none | stop | pause = none

onCategoryOnCategoryItem[]

Show child parameters

categorystringrequired

sequenceIdstringrequired

stopCurrentboolean

= true

ownerUserIdstring

scheduleIdstring

dedupeobject

Show child parameters

crossSequencestring

skip | allow = skip

contactedWithinDaysinteger

= 0

domainboolean

= false

startAtstring

minGapMinutesinteger

senderOverridesobject

abmobject

Show child parameters

maxPerAccountinteger

= 5

onAccountReplystring

none | stop | pause = stop

{
  "name": "string",
  "settings": {
    "steps": [
      {
        "type": "email",
        "templateId": "string",
        "versionId": "string",
        "thread": "new",
        "waitDays": 0,
        "businessDays": false,
        "when": {
          "kind": "engagement",
          "event": "opened",
          "negate": false
        },
        "window": {
          "startMin": 0,
          "endMin": 0,
          "weekdays": [
            0
          ]
        },
        "alternates": [],
        "weightA": 1,
        "optimize": false,
        "senderConnectionId": "string"
      }
    ],
    "schedule": {
      "weekdays": [
        1,
        2,
        3,
        4,
        5
      ],
      "startMin": 540,
      "endMin": 1020,
      "timezoneSource": "prospect",
      "timezone": "UTC"
    },
    "mailbox": {
      "poolId": "string",
      "connectionId": "string",
      "sticky": true,
      "onUnavailable": "pause"
    },
    "dailyNewLimit": 0,
    "followUpPercent": 0,
    "plainTextOnly": true,
    "trackOpens": true,
    "unsubscribeText": "string",
    "spintaxMode": "random",
    "variables": {},
    "blocklist": {
      "emails": [
        "string"
      ],
      "domains": []
    },
    "reviewBeforeSend": true,
    "reviewEachMessage": true,
    "stop": {
      "onReply": "human",
      "onAutoReply": "continue",
      "onOoo": "pause_until_return",
      "onCompanyReply": "none"
    },
    "onCategory": [
      {
        "category": "positive",
        "sequenceId": "string",
        "stopCurrent": true
      }
    ],
    "ownerUserId": "string",
    "scheduleId": "string",
    "dedupe": {
      "crossSequence": "skip",
      "contactedWithinDays": 0,
      "domain": false
    },
    "startAt": "2024-01-01T00:00:00Z",
    "minGapMinutes": 0,
    "senderOverrides": {},
    "abm": {
      "maxPerAccount": 5,
      "onAccountReply": "stop"
    }
  }
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/outbound/sequences/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","settings":{"steps":[{"type":"email","templateId":"string","versionId":"string","thread":"new","waitDays":0,"businessDays":false,"when":{"kind":"engagement","event":"opened","negate":false},"window":{"startMin":0,"endMin":0,"weekdays":[0]},"alternates":[],"weightA":1,"optimize":false,"senderConnectionId":"string"}],"schedule":{"weekdays":[1,2,3,4,5],"startMin":540,"endMin":1020,"timezoneSource":"prospect","timezone":"UTC"},"mailbox":{"poolId":"string","connectionId":"string","sticky":true,"onUnavailable":"pause"},"dailyNewLimit":0,"followUpPercent":0,"plainTextOnly":true,"trackOpens":true,"unsubscribeText":"string","spintaxMode":"random","variables":{},"blocklist":{"emails":["string"],"domains":[]},"reviewBeforeSend":true,"reviewEachMessage":true,"stop":{"onReply":"human","onAutoReply":"continue","onOoo":"pause_until_return","onCompanyReply":"none"},"onCategory":[{"category":"positive","sequenceId":"string","stopCurrent":true}],"ownerUserId":"string","scheduleId":"string","dedupe":{"crossSequence":"skip","contactedWithinDays":0,"domain":false},"startAt":"2024-01-01T00:00:00Z","minGapMinutes":0,"senderOverrides":{},"abm":{"maxPerAccount":5,"onAccountReply":"stop"}}}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "name": "string",
  "purpose": "marketing",
  "mode": "sequence",
  "status": "draft",
  "publishedVersionId": "string",
  "folder": "string",
  "tags": [
    "string"
  ],
  "sequence": {
    "steps": [],
    "schedule": {
      "weekdays": [
        1,
        2,
        3,
        4,
        5
      ],
      "startMin": 540,
      "endMin": 1020,
      "timezoneSource": "prospect",
      "timezone": "UTC"
    },
    "mailbox": {
      "sticky": true,
      "onUnavailable": "pause"
    },
    "dailyNewLimit": 0,
    "followUpPercent": 0,
    "plainTextOnly": true,
    "trackOpens": true,
    "unsubscribeText": "string",
    "spintaxMode": "random",
    "variables": {},
    "blocklist": {
      "emails": [],
      "domains": []
    },
    "reviewBeforeSend": true,
    "reviewEachMessage": true,
    "stop": {
      "onReply": "human",
      "onAutoReply": "continue",
      "onOoo": "pause_until_return",
      "onCompanyReply": "none"
    },
    "onCategory": [
      {
        "category": "positive",
        "sequenceId": "string",
        "stopCurrent": true
      }
    ],
    "ownerUserId": "string",
    "scheduleId": "string",
    "dedupe": {
      "crossSequence": "skip",
      "contactedWithinDays": 0,
      "domain": false
    },
    "startAt": "2024-01-01T00:00:00Z",
    "minGapMinutes": 0,
    "senderOverrides": {},
    "abm": {
      "maxPerAccount": 5,
      "onAccountReply": "stop"
    }
  },
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

namestringrequired

purposestringrequired

marketing | prospecting | transactional | operational

modestringrequired

sequence

statusstringrequired

draft | live | paused | archived

publishedVersionIdstringrequired

folderstringrequired

tagsstring[]required

sequenceobjectrequired

Show child parameters

stepsStepsItem3[]required

= []

scheduleobjectrequired

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

Show child parameters

weekdaysinteger[]required

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

startMinintegerrequired

= 540

endMinintegerrequired

= 1020

timezoneSourcestringrequired

prospect | sequence = prospect

timezonestringrequired

= UTC

mailboxobjectrequired

= {"sticky":true,"onUnavailable":"pause"}

Show child parameters

poolIdstring

connectionIdstring

stickybooleanrequired

= true

onUnavailablestringrequired

pause | reassign = pause

dailyNewLimitinteger

followUpPercentinteger

plainTextOnlyboolean

trackOpensboolean

unsubscribeTextstring

spintaxModestring

random | sequential

variablesobject

blocklistobject

Show child parameters

emailsobject[]required

= []

domainsstring[]required

= []

reviewBeforeSendboolean

reviewEachMessageboolean

stopobjectrequired

= {"onReply":"human","onAutoReply":"continue","onOoo":"pause_until_return","onCompanyReply":"none"}

Show child parameters

onReplystringrequired

human | any = human

onAutoReplystringrequired

continue | pause = continue

onOoostringrequired

pause_until_return | continue | stop = pause_until_return

onCompanyReplystringrequired

none | stop | pause = none

onCategoryOnCategoryItem2[]

Show child parameters

categorystringrequired

sequenceIdstringrequired

stopCurrentbooleanrequired

= true

ownerUserIdstring

scheduleIdstring

dedupeobjectrequired

= {"crossSequence":"skip","contactedWithinDays":0,"domain":false}

Show child parameters

crossSequencestringrequired

skip | allow = skip

contactedWithinDaysintegerrequired

= 0

domainbooleanrequired

= false

startAtstring

minGapMinutesinteger

senderOverridesobject

abmobject

Show child parameters

maxPerAccountintegerrequired

= 5

onAccountReplystringrequired

none | stop | pause = stop

createdAtstringrequired

updatedAtstringrequired

4XX Default Response

Same as 4XX · DELETE /v1/outbound/sequences/{id}

5XX Default Response

Same as 4XX · DELETE /v1/outbound/sequences/{id}

POSThttps://hermeticor.com/v1/outbound/sequences/{id}/publish

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PATCH /v1/outbound/sequences/{id}

4XX Default Response

Same as 4XX · DELETE /v1/outbound/sequences/{id}

5XX Default Response

Same as 4XX · DELETE /v1/outbound/sequences/{id}

POSThttps://hermeticor.com/v1/outbound/sequences/{id}/pause

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PATCH /v1/outbound/sequences/{id}

4XX Default Response

Same as 4XX · DELETE /v1/outbound/sequences/{id}

5XX Default Response

Same as 4XX · DELETE /v1/outbound/sequences/{id}

POSThttps://hermeticor.com/v1/outbound/sequences/{id}/resume

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PATCH /v1/outbound/sequences/{id}

4XX Default Response

Same as 4XX · DELETE /v1/outbound/sequences/{id}

5XX Default Response

Same as 4XX · DELETE /v1/outbound/sequences/{id}

Next part

Updated Nov 8, 2026

Was this page helpful?