Delete an agent calendar

POST
/v1/calendar/calendars/remove

Permanently deletes a calendar that was made for an agent, with all its meetings. A calendar the person already had is never deleted from here. Without confirm: true it is refused with a sentence that names what would be lost.

Requires an API key with the calendar:use scope.

Authorization

apiKey
headerAuthorizationBearer <token>

A secret API key from the dashboard (Developers → API keys): vl_live_…, or vl_test_… for test mode. Each operation says which scope the key needs.

Request Body

application/json
  1. body
calendarId*string

The calendar to delete, one made for an agent (the list marks those).

Length1 <= length <= 320
confirm*boolean

Set to true only after the person said yes to permanently deleting the calendar and its meetings.

connectionId?string

Only needed when more than one calendar account is connected.

Length1 <= length <= 64

Response Body

Deleted

application/json
  1. response
removed*string
summary*string
Example Request
curl -X POST https://api.vlayers.ai/v1/calendar/calendars/remove \  -H "Authorization: Bearer $VOICELAYER_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "calendarId": "[email protected]",    "confirm": true  }'
Example Response
{  "removed": "[email protected]",  "summary": "Deleted the calendar \"Sales agent\" and its meetings."}