outbound

Embed
Preview of the card
<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/booking-pages/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/outbound/booking-pages/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
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/booking-pages/{id}

GEThttps://hermeticor.com/v1/outbound/booking-pages/{id}/bookings

Parameters

limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page
idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/outbound/booking-pages/{id}/bookings" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "pageId": "string",
      "profileId": "string",
      "meetingId": "string",
      "startAt": "2024-01-01T00:00:00Z",
      "endAt": "2024-01-01T00:00:00Z",
      "name": "string",
      "email": "string",
      "notes": "string",
      "consented": true,
      "status": "confirmed",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem222[]required
Show child parameters
idstringrequired
pageIdstringrequired
profileIdstringrequired
meetingIdstringrequired
startAtstringrequired
endAtstringrequired
namestringrequired
emailstringrequired
notesstringrequired
consentedbooleanrequired
statusstringrequired
confirmed | cancelled
createdAtstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · DELETE /v1/outbound/booking-pages/{id}

5XX Default Response

Same as 4XX · DELETE /v1/outbound/booking-pages/{id}

POSThttps://hermeticor.com/v1/outbound/bookings/{id}/cancel

Parameters

idstringpathrequired

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/outbound/bookings/{id}/cancel" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "id": "string",
  "pageId": "string",
  "profileId": "string",
  "meetingId": "string",
  "startAt": "2024-01-01T00:00:00Z",
  "endAt": "2024-01-01T00:00:00Z",
  "name": "string",
  "email": "string",
  "notes": "string",
  "consented": true,
  "status": "confirmed",
  "createdAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
pageIdstringrequired
profileIdstringrequired
meetingIdstringrequired
startAtstringrequired
endAtstringrequired
namestringrequired
emailstringrequired
notesstringrequired
consentedbooleanrequired
statusstringrequired
confirmed | cancelled
createdAtstringrequired
4XX Default Response

Same as 4XX · DELETE /v1/outbound/booking-pages/{id}

5XX Default Response

Same as 4XX · DELETE /v1/outbound/booking-pages/{id}

GEThttps://hermeticor.com/v1/public/booking/{ws}/{slug}/slots

Open start times of a booking page (JSON)

Parameters

wsstringpathrequired
slugstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/public/booking/{ws}/{slug}/slots"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "timezone": "string",
  "durationMin": 0,
  "slots": [
    "string"
  ]
}
Schema
timezonestringrequired
durationMinintegerrequired
slotsstring[]required
4XX Default Response

Same as 4XX · DELETE /v1/outbound/booking-pages/{id}

5XX Default Response

Same as 4XX · DELETE /v1/outbound/booking-pages/{id}

GEThttps://hermeticor.com/book/{ws}/{slug}

Hosted booking page

Parameters

wsstringpathrequired
slugstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/book/{ws}/{slug}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · DELETE /v1/outbound/booking-pages/{id}

5XX Default Response

Same as 4XX · DELETE /v1/outbound/booking-pages/{id}

POSThttps://hermeticor.com/book/{ws}/{slug}

Book a time on a booking page (consent is recorded only when the visitor ticks the box)

Parameters

wsstringpathrequired
slugstringpathrequired

Request body

application/json
{}

Code samples

cURL
curl -X POST "https://hermeticor.com/book/{ws}/{slug}" \
  -H "Content-Type: application/json" \
  -d '{}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · DELETE /v1/outbound/booking-pages/{id}

5XX Default Response

Same as 4XX · DELETE /v1/outbound/booking-pages/{id}

Updated