Sign in
Teams

Create a team

post/v2/teams

Headers

Authorizationstring required

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

Request body

namestring required

Name of the team

slugstring

Team slug in kebab-case - if not provided will be generated automatically based on name.

logoUrlstring

URL of the teams logo image

calVideoLogostring
appLogostring
appIconLogostring
biostring
hideBrandingboolean
isPrivateboolean
hideBookATeamMemberboolean
metadataobject

You can store any additional data you want here. Metadata must have at most 50 keys, each key up to 40 characters. Values can be strings (up to 500 characters), numbers, or booleans.

themestring
brandColorstring
darkBrandColorstring
bannerUrlstring

URL of the teams banner image which is shown on booker

timeFormatnumber
timeZonestring

Timezone is used to create teams's default schedule from Monday to Friday from 9AM to 5PM. It will default to Europe/London if not passed.

weekStartstring
autoAcceptCreatorboolean

If you are a platform customer, don't pass 'false', because then team creator won't be able to create team event types.

Example request

{
  "name": "CalTeam",
  "slug": "caltel",
  "logoUrl": "https://i.cal.com/api/avatar/b0b58752-68ad-4c0d-8024-4fa382a77752.png",
  "metadata": {
    "key": "value"
  },
  "bannerUrl": "https://i.cal.com/api/avatar/949be534-7a88-4185-967c-c020b0c0bef3.png",
  "timeZone": "America/New_York",
  "weekStart": "Monday"
}

Response

status'success' | 'error' required

Example response

{
  "status": "success",
  "data": {
    "pendingTeam": {
      "metadata": {
        "key": "value"
      }
    }
  }
}

Changes