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/meetings

Request body

application/json

profileIdstringrequired

atstring

refstring

{
  "profileId": "string",
  "at": "2024-01-01T00:00:00Z",
  "ref": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/meetings" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"profileId":"string","at":"2024-01-01T00:00:00Z","ref":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "profileId": "string",
  "source": "calendar_link",
  "at": "2024-01-01T00:00:00Z",
  "ref": "string",
  "sequenceId": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "completedAt": "2024-01-01T00:00:00Z",
  "outcome": "string"
}

Schema

idstringrequired

profileIdstringrequired

sourcestringrequired

calendar_link | reply_detected | manual

atstringrequired

refstringrequired

sequenceIdstringrequired

createdAtstringrequired

completedAtstring

outcomestring

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/meetings

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

Parameters

fromstringquery

tostringquery

sequenceIdstringquery

groupstringquery

sequence | step | mailbox = sequence

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "key": "string",
      "sent": 0,
      "bounced": 0,
      "replied": 0,
      "positive": 0,
      "negative": 0,
      "optOuts": 0,
      "meetings": 0,
      "positiveRate": 0,
      "replyRate": 0,
      "bounceRate": 0
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

keystringrequired

sentintegerrequired

bouncedintegerrequired

repliedintegerrequired

positiveintegerrequired

negativeintegerrequired

optOutsintegerrequired

meetingsintegerrequired

positiveRatenumberrequired

replyRatenumberrequired

bounceRatenumberrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/meetings

5XX Default Response

Same as 4XX · POST /v1/outbound/meetings

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

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "connectionId": "string",
      "name": "string",
      "status": "string",
      "health": "string",
      "dailyCap": 0,
      "hourlyCap": 0,
      "ramp": {
        "startDaily": 0,
        "targetDaily": 0,
        "incrementPerDay": 0,
        "startedOn": "string"
      },
      "timezone": "string",
      "sendingWindow": {
        "startMin": 0,
        "endMin": 0,
        "weekdays": [
          0
        ]
      },
      "pacing": {
        "minGapSec": 0,
        "jitterSec": 0
      },
      "sentToday": 0,
      "bounceRate7d": 0,
      "replyRate7d": 0,
      "totals": {
        "sent": 0,
        "bounced": 0,
        "complaints": 0,
        "replied": 0
      },
      "factors": [
        {
          "key": "string",
          "ok": true,
          "value": 0,
          "limit": 0
        }
      ],
      "pause": "string",
      "history": [
        {
          "day": "string",
          "sent": 0,
          "bounced": 0,
          "replied": 0,
          "complaints": 0,
          "opens": 0,
          "clicks": 0
        }
      ]
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem86[]required

Show child parameters

connectionIdstringrequired

namestringrequired

statusstringrequired

healthstringrequired

dailyCapintegerrequired

hourlyCapintegerrequired

rampobjectrequired

Show child parameters

startDailyintegerrequired

targetDailyintegerrequired

incrementPerDayintegerrequired

startedOnstringrequired

timezonestringrequired

sendingWindowobjectrequired

Show child parameters

startMinintegerrequired

endMinintegerrequired

weekdaysinteger[]

pacingobjectrequired

Show child parameters

minGapSecintegerrequired

jitterSecintegerrequired

sentTodayintegerrequired

bounceRate7dnumberrequired

replyRate7dnumberrequired

totalsobjectrequired

Show child parameters

sentintegerrequired

bouncedintegerrequired

complaintsintegerrequired

repliedintegerrequired

factorsFactorsItem[]required

Show child parameters

keystringrequired

okbooleanrequired

valuenumber | stringrequired

limitnumber | string

pausestringrequired

historyHistoryItem[]required

Show child parameters

daystringrequired

sentintegerrequired

bouncedintegerrequired

repliedintegerrequired

complaintsintegerrequired

opensintegerrequired

clicksintegerrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/meetings

5XX Default Response

Same as 4XX · POST /v1/outbound/meetings

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

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "connectionId": "string",
  "name": "string",
  "status": "string",
  "health": "string",
  "dailyCap": 0,
  "hourlyCap": 0,
  "ramp": {
    "startDaily": 0,
    "targetDaily": 0,
    "incrementPerDay": 0,
    "startedOn": "string"
  },
  "timezone": "string",
  "sendingWindow": {
    "startMin": 0,
    "endMin": 0,
    "weekdays": [
      0
    ]
  },
  "pacing": {
    "minGapSec": 0,
    "jitterSec": 0
  },
  "sentToday": 0,
  "bounceRate7d": 0,
  "replyRate7d": 0,
  "totals": {
    "sent": 0,
    "bounced": 0,
    "complaints": 0,
    "replied": 0
  },
  "factors": [
    {
      "key": "string",
      "ok": true,
      "value": 0,
      "limit": 0
    }
  ],
  "pause": "string",
  "history": [
    {
      "day": "string",
      "sent": 0,
      "bounced": 0,
      "replied": 0,
      "complaints": 0,
      "opens": 0,
      "clicks": 0
    }
  ]
}

Schema

connectionIdstringrequired

namestringrequired

statusstringrequired

healthstringrequired

dailyCapintegerrequired

hourlyCapintegerrequired

rampobjectrequired

Show child parameters

startDailyintegerrequired

targetDailyintegerrequired

incrementPerDayintegerrequired

startedOnstringrequired

timezonestringrequired

sendingWindowobjectrequired

Show child parameters

startMinintegerrequired

endMinintegerrequired

weekdaysinteger[]

pacingobjectrequired

Show child parameters

minGapSecintegerrequired

jitterSecintegerrequired

sentTodayintegerrequired

bounceRate7dnumberrequired

replyRate7dnumberrequired

totalsobjectrequired

Show child parameters

sentintegerrequired

bouncedintegerrequired

complaintsintegerrequired

repliedintegerrequired

factorsFactorsItem[]required

Show child parameters

keystringrequired

okbooleanrequired

valuenumber | stringrequired

limitnumber | string

pausestringrequired

historyHistoryItem[]required

Show child parameters

daystringrequired

sentintegerrequired

bouncedintegerrequired

repliedintegerrequired

complaintsintegerrequired

opensintegerrequired

clicksintegerrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/meetings

5XX Default Response

Same as 4XX · POST /v1/outbound/meetings

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

Parameters

idstringpathrequired

Request body

application/json

dailyCapinteger

hourlyCapinteger

rampobject

Show child parameters

startDailyintegerrequired

targetDailyintegerrequired

incrementPerDayintegerrequired

startedOnstringrequired

timezonestring

sendingWindowobject

Show child parameters

startMinintegerrequired

endMinintegerrequired

weekdaysinteger[]

pacingobject

Show child parameters

minGapSecintegerrequired

jitterSecintegerrequired

{
  "dailyCap": 0,
  "hourlyCap": 0,
  "ramp": {
    "startDaily": 0,
    "targetDaily": 0,
    "incrementPerDay": 0,
    "startedOn": "string"
  },
  "timezone": "string",
  "sendingWindow": {
    "startMin": 0,
    "endMin": 0,
    "weekdays": [
      0
    ]
  },
  "pacing": {
    "minGapSec": 0,
    "jitterSec": 0
  }
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/outbound/mailboxes/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"dailyCap":0,"hourlyCap":0,"ramp":{"startDaily":0,"targetDaily":0,"incrementPerDay":0,"startedOn":"string"},"timezone":"string","sendingWindow":{"startMin":0,"endMin":0,"weekdays":[0]},"pacing":{"minGapSec":0,"jitterSec":0}}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · POST /v1/outbound/meetings

5XX Default Response

Same as 4XX · POST /v1/outbound/meetings

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

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

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

4XX Default Response

Same as 4XX · POST /v1/outbound/meetings

5XX Default Response

Same as 4XX · POST /v1/outbound/meetings

Next part

Updated Nov 8, 2026

Was this page helpful?