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/calendar-feeds/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/calendar-feeds/{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/calendar-feeds/{id}

PATCHhttps://hermeticor.com/v1/calendar-feeds/{id}

Parameters

idstringpathrequired

Request body

application/json

namestring

taskScopestring

mine | all

includeTasksboolean

includeCampaignsboolean

{
  "name": "string",
  "taskScope": "mine",
  "includeTasks": true,
  "includeCampaigns": true
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/calendar-feeds/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","taskScope":"mine","includeTasks":true,"includeCampaigns":true}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "name": "string",
  "taskScope": "mine",
  "includeTasks": true,
  "includeCampaigns": true,
  "id": "string",
  "tokenLast4": "string",
  "ownerUserId": "string",
  "lastAccessedAt": "2024-01-01T00:00:00Z",
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

namestringrequired

taskScopestringrequired

mine | all = mine

includeTasksbooleanrequired

= true

includeCampaignsbooleanrequired

= true

idstringrequired

tokenLast4stringrequired

ownerUserIdstringrequired

lastAccessedAtstringrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · DELETE /v1/calendar-feeds/{id}

5XX Default Response

Same as 4XX · DELETE /v1/calendar-feeds/{id}

POSThttps://hermeticor.com/v1/calendar-feeds/{id}/rotate

New subscription URL; the old one stops working

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/calendar-feeds/{id}/rotate" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "feed": {
    "name": "string",
    "taskScope": "mine",
    "includeTasks": true,
    "includeCampaigns": true,
    "id": "string",
    "tokenLast4": "string",
    "ownerUserId": "string",
    "lastAccessedAt": "2024-01-01T00:00:00Z",
    "createdAt": "2024-01-01T00:00:00Z"
  },
  "url": "string"
}

Schema

feedobjectrequired

Show child parameters

namestringrequired

taskScopestringrequired

mine | all = mine

includeTasksbooleanrequired

= true

includeCampaignsbooleanrequired

= true

idstringrequired

tokenLast4stringrequired

ownerUserIdstringrequired

lastAccessedAtstringrequired

createdAtstringrequired

urlstringrequired

4XX Default Response

Same as 4XX · DELETE /v1/calendar-feeds/{id}

5XX Default Response

Same as 4XX · DELETE /v1/calendar-feeds/{id}

GEThttps://hermeticor.com/ical/{ws}/{file}

The ICS feed itself (token in the URL). Titles and times only, never message bodies

Parameters

wsstringpathrequired

filestringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/ical/{ws}/{file}"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

"string"

4XX Default Response

Same as 4XX · DELETE /v1/calendar-feeds/{id}

5XX Default Response

Same as 4XX · DELETE /v1/calendar-feeds/{id}

GEThttps://hermeticor.com/v1/outbound/booking-pages

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "slug": "string",
      "name": "string",
      "description": "string",
      "durationMin": 30,
      "bufferMin": 0,
      "noticeMin": 240,
      "horizonDays": 30,
      "timezone": "UTC",
      "hours": [],
      "connectionId": "string",
      "consentText": "string",
      "active": true,
      "id": "string",
      "ownerUserId": "string",
      "url": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem221[]required

Show child parameters

slugstringrequired

namestringrequired

descriptionstring

durationMinintegerrequired

= 30

bufferMinintegerrequired

= 0

noticeMinintegerrequired

= 240

horizonDaysintegerrequired

= 30

timezonestringrequired

= UTC

hoursHoursItem[]required

= []

Show child parameters

weekdayintegerrequired

startMinintegerrequired

endMinintegerrequired

connectionIdstring

consentTextstring

activebooleanrequired

= true

idstringrequired

ownerUserIdstringrequired

urlstringrequired

createdAtstringrequired

updatedAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · DELETE /v1/calendar-feeds/{id}

5XX Default Response

Same as 4XX · DELETE /v1/calendar-feeds/{id}

POSThttps://hermeticor.com/v1/outbound/booking-pages

Request body

application/json

slugstringrequired

namestringrequired

descriptionstring

durationMininteger

= 30

bufferMininteger

= 0

noticeMininteger

= 240

horizonDaysinteger

= 30

timezonestring

= UTC

hoursHoursItem2[]

= []

Show child parameters

weekdayintegerrequired

startMinintegerrequired

endMinintegerrequired

connectionIdstring

consentTextstring

activeboolean

= true

{
  "slug": "string",
  "name": "string",
  "description": "string",
  "durationMin": 30,
  "bufferMin": 0,
  "noticeMin": 240,
  "horizonDays": 30,
  "timezone": "UTC",
  "hours": [],
  "connectionId": "string",
  "consentText": "string",
  "active": true
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/booking-pages" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"slug":"string","name":"string","description":"string","durationMin":30,"bufferMin":0,"noticeMin":240,"horizonDays":30,"timezone":"UTC","hours":[],"connectionId":"string","consentText":"string","active":true}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "slug": "string",
  "name": "string",
  "description": "string",
  "durationMin": 30,
  "bufferMin": 0,
  "noticeMin": 240,
  "horizonDays": 30,
  "timezone": "UTC",
  "hours": [],
  "connectionId": "string",
  "consentText": "string",
  "active": true,
  "id": "string",
  "ownerUserId": "string",
  "url": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}

Schema

slugstringrequired

namestringrequired

descriptionstring

durationMinintegerrequired

= 30

bufferMinintegerrequired

= 0

noticeMinintegerrequired

= 240

horizonDaysintegerrequired

= 30

timezonestringrequired

= UTC

hoursHoursItem[]required

= []

Show child parameters

weekdayintegerrequired

startMinintegerrequired

endMinintegerrequired

connectionIdstring

consentTextstring

activebooleanrequired

= true

idstringrequired

ownerUserIdstringrequired

urlstringrequired

createdAtstringrequired

updatedAtstringrequired

4XX Default Response

Same as 4XX · DELETE /v1/calendar-feeds/{id}

5XX Default Response

Same as 4XX · DELETE /v1/calendar-feeds/{id}

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

Parameters

idstringpathrequired

Request body

application/json

slugstringrequired

namestringrequired

descriptionstring

durationMininteger

= 30

bufferMininteger

= 0

noticeMininteger

= 240

horizonDaysinteger

= 30

timezonestring

= UTC

hoursHoursItem2[]

= []

Show child parameters

weekdayintegerrequired

startMinintegerrequired

endMinintegerrequired

connectionIdstring

consentTextstring

activeboolean

= true

{
  "slug": "string",
  "name": "string",
  "description": "string",
  "durationMin": 30,
  "bufferMin": 0,
  "noticeMin": 240,
  "horizonDays": 30,
  "timezone": "UTC",
  "hours": [],
  "connectionId": "string",
  "consentText": "string",
  "active": true
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/outbound/booking-pages/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"slug":"string","name":"string","description":"string","durationMin":30,"bufferMin":0,"noticeMin":240,"horizonDays":30,"timezone":"UTC","hours":[],"connectionId":"string","consentText":"string","active":true}'

TypeScript

Python

PHP

Ruby

Java