Sign in

v1

latestOpenAPI 3.0.02026-07-17121287546.7 KB
Deprecated: Platform OAuth Clients

Update an OAuth client

<Warning>These endpoints are deprecated and will be removed in the future.</Warning>

patch/v2/oauth-clients/{clientId}

Path parameters

clientIdstring required

Headers

Authorizationstring required

value must be Bearer <token> where <token> is api key prefixed with cal_

Request body

logostring
namestring
redirectUrisstring[]
bookingRedirectUristring
bookingCancelRedirectUristring
bookingRescheduleRedirectUristring
areEmailsEnabledboolean
areDefaultEventTypesEnabledboolean

If true, when creating a managed user the managed user will have 4 default event types: 30 and 60 minutes without Cal video, 30 and 60 minutes with Cal video. Set this as false if you want to create a managed user and then manually create event types for the user.

areCalendarEventsEnabledboolean

If true and if managed user has calendar connected, calendar events will be created. Disable it if you manually create calendar events. Default to true.

Response

status'success' | 'error' required

Example response

{
  "status": "success",
  "data": {
    "id": "clsx38nbl0001vkhlwin9fmt0",
    "name": "MyClient",
    "secret": "secretValue",
    "permissions": [
      "BOOKING_READ",
      "BOOKING_WRITE"
    ],
    "redirectUris": [
      "https://example.com/callback"
    ],
    "organizationId": 1,
    "createdAt": "2024-03-23T08:33:21.851Z",
    "areEmailsEnabled": true,
    "areDefaultEventTypesEnabled": true,
    "areCalendarEventsEnabled": true,
    "bookingRedirectUri": "https://example.com/booking-redirect",
    "bookingCancelRedirectUri": "https://example.com/booking-cancel",
    "bookingRescheduleRedirectUri": "https://example.com/booking-reschedule"
  }
}