Delete a user

Headers

Authorization

string

For non-platform customers - value must be Bearer <token> where <token> is api key prefixed with cal_

x-cal-secret-key

string

For platform customers - OAuth client secret key

x-cal-client-id

string

For platform customers - OAuth client ID

Path Parameters

orgId

number

required

userId

number

required

Response

200 - application/json

status

enum<string>

required

Available options:

success,

error

Example:

"success"

data

object

required

Show child attributes

data.id

number

required

The ID of the user

Example:

1

data.email

string

required

The email of the user

Example:

"[e-mail]"

data.timeZone

string

required

The time zone of the user

Example:

"America/New_York"

data.weekStart

string

required

The week start day of the user

Example:

"Monday"

data.hideBranding

boolean

required

Whether to hide branding for the user

Example:

false

data.createdDate

string

required

The date when the user was created

Example:

"2022-01-01T00:00:00Z"

data.profile

object

required

organization user profile, contains user data within the organizaton context

Show child attributes

data.profile.id

number

required

The ID of the profile of user

Example:

1

data.profile.organizationId

number

required

The ID of the organization of user

Example:

1

data.profile.userId

number

required

The IDof the user

Example:

1

data.profile.username

string | null

The username of the user within the organization context

Example:

"john_doe"

data.username

string | null

The username of the user

Example:

"john_doe"

data.name

string | null

The name of the user

Example:

"John Doe"

data.emailVerified

string | null

The date when the email was verified

Example:

"2022-01-01T00:00:00Z"

data.bio

string | null

The bio of the user

Example:

"I am a software developer"

data.avatarUrl

string | null

The URL of the user's avatar

Example:

"https://example.com/avatar.jpg"

data.appTheme

string | null

The app theme of the user

Example:

"light"

data.theme

string | null

The theme of the user

Example:

"default"

data.defaultScheduleId

number | null

The ID of the default schedule for the user

Example:

1

data.locale

string | null

The locale of the user

Example:

"en-US"

data.timeFormat

number | null

The time format of the user

Example:

12

data.brandColor

string | null

The brand color of the user

Example:

"#ffffff"

data.darkBrandColor

string | null

The dark brand color of the user

Example:

"#000000"

data.allowDynamicBooking

boolean | null

Whether dynamic booking is allowed for the user

Example:

true

data.verified

boolean | null

Whether the user is verified

Example:

true

data.invitedTo

number | null

The ID of the user who invited this user

Example:

1

data.metadata

object

Example:

{ "key": "value" }