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}/steps/{stepKey}/winner

Make one A/B variant the step's only template (takes effect on the next publish)

Parameters

idstringpathrequired

stepKeystringpathrequired

Request body

application/json

variantstringrequired

{
  "variant": "string"
}

Code samples

cURL

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

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

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}/steps/{stepKey}/winner

GEThttps://hermeticor.com/v1/outbound/reply-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-labels" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "color": "string",
      "description": "string",
      "parentCategory": "positive",
      "triggerSequenceId": "string",
      "stopCurrent": true,
      "aiHint": "string",
      "uses": 0,
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem129[]required

Show child parameters

idstringrequired

namestringrequired

colorstringrequired

descriptionstringrequired

parentCategorystringrequired

triggerSequenceIdstringrequired

stopCurrentbooleanrequired

aiHintstringrequired

usesintegerrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/sequences/{id}/steps/{stepKey}/winner

5XX Default Response

Same as 4XX · POST /v1/outbound/sequences/{id}/steps/{stepKey}/winner

POSThttps://hermeticor.com/v1/outbound/reply-labels

Request body

application/json

namestringrequired

colorstring

= #6b7280

descriptionstring

parentCategorystring

triggerSequenceIdstring

stopCurrentboolean

= true

aiHintstring

{
  "name": "string",
  "color": "#6b7280",
  "description": "string",
  "parentCategory": "positive",
  "triggerSequenceId": "string",
  "stopCurrent": true,
  "aiHint": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/reply-labels" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","color":"#6b7280","description":"string","parentCategory":"positive","triggerSequenceId":"string","stopCurrent":true,"aiHint":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "name": "string",
  "color": "string",
  "description": "string",
  "parentCategory": "positive",
  "triggerSequenceId": "string",
  "stopCurrent": true,
  "aiHint": "string",
  "uses": 0,
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

namestringrequired

colorstringrequired

descriptionstringrequired

parentCategorystringrequired

triggerSequenceIdstringrequired

stopCurrentbooleanrequired

aiHintstringrequired

usesintegerrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/sequences/{id}/steps/{stepKey}/winner

5XX Default Response

Same as 4XX · POST /v1/outbound/sequences/{id}/steps/{stepKey}/winner

GEThttps://hermeticor.com/v1/outbound/reply-labels/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/outbound/reply-labels

4XX Default Response

Same as 4XX · POST /v1/outbound/sequences/{id}/steps/{stepKey}/winner

5XX Default Response

Same as 4XX · POST /v1/outbound/sequences/{id}/steps/{stepKey}/winner

PUThttps://hermeticor.com/v1/outbound/reply-labels/{id}

Parameters

idstringpathrequired

Request body

application/json

namestringrequired

colorstring

= #6b7280

descriptionstring

parentCategorystring

triggerSequenceIdstring

stopCurrentboolean

= true

aiHintstring

{
  "name": "string",
  "color": "#6b7280",
  "description": "string",
  "parentCategory": "positive",
  "triggerSequenceId": "string",
  "stopCurrent": true,
  "aiHint": "string"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/outbound/reply-labels/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","color":"#6b7280","description":"string","parentCategory":"positive","triggerSequenceId":"string","stopCurrent":true,"aiHint":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/outbound/reply-labels

4XX Default Response

Same as 4XX · POST /v1/outbound/sequences/{id}/steps/{stepKey}/winner

5XX Default Response

Same as 4XX · POST /v1/outbound/sequences/{id}/steps/{stepKey}/winner

DELETEhttps://hermeticor.com/v1/outbound/reply-labels/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/outbound/reply-labels/{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

Same as 4XX · POST /v1/outbound/sequences/{id}/steps/{stepKey}/winner

5XX Default Response

Same as 4XX · POST /v1/outbound/sequences/{id}/steps/{stepKey}/winner

Next part

Updated Nov 8, 2026

Was this page helpful?