Sign in
Deprecated: Platform OAuth Clients

Create an OAuth client

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

post/v2/oauth-clients

Request

  • The document declares no server URL.
  • Auth: none declared. Required headers: Authorization

Headers

Authorizationstring required

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

Request body

logostring
namestring required
redirectUrisstring[] required
permissionsstring[] required

Array of permission keys like ["BOOKING_READ", "BOOKING_WRITE"]. Use ["*"] to grant all permissions.

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

Create an OAuth client

status'success' | 'error' required

Example response

{
  "status": "success",
  "data": {
    "clientId": "clsx38nbl0001vkhlwin9fmt0",
    "clientSecret": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoib2F1dGgtY2xpZW50Iiwi"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.