POST
/
users
curl --request POST \
  --url https://api.cal.com/v1/users \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "email@example.com",
  "username": "johndoe",
  "weekStart": "MONDAY",
  "brandColor": "#555555",
  "darkBrandColor": "#111111",
  "timeZone": "EUROPE/PARIS",
  "theme": "LIGHT",
  "timeFormat": "TWELVE",
  "locale": "FR"
}'

Authorizations

​
apiKey
string
query
required

Query Parameters

​
apiKey
string
required

Your API key

Body

application/json
Create a new user
​
email
string
required

Email that belongs to the user being edited

​
username
string
required

Username for the user being created

​
brandColor
string

The new user's brand color

​
darkBrandColor
string

The new user's brand color for dark mode

​
hideBranding
boolean

Remove branding from the user's calendar page

​
weekStart
string

Start of the week. Acceptable values are one of [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]

​
timeZone
string

The new user's time zone. Eg- 'EUROPE/PARIS'

​
theme
string

Default theme for the new user. Acceptable values are one of [DARK, LIGHT]

​
timeFormat
string

The new user's time format. Acceptable values are one of [TWELVE, TWENTY_FOUR]

​
locale
string

The new user's locale. Acceptable values are one of [EN, FR, IT, RU, ES, DE, PT, RO, NL, PT_BR, ES_419, KO, JA, PL, AR, IW, ZH_CH, ZH_TW, CS, SR, SV, VI]

​
avatar
string

The user's avatar, in base64 format

Response

201

OK, user created

Was this page helpful?

Suggest editsRaise issue