---
title: "Create user"
method: POST
path: "/users"
tags: ["Users"]
---

# Create user

`POST /users`

Create a new user. After creation, please use "Assign roles" endpoint to grant roles to the user, and "Assign scope" endpoint to assign a scope of permitted properties.

## Request body

- object
  - `email` string, required
  - `emails` string[]
  - `firstName` string, required
  - `lastName` string, required
  - `title` string
  - `timezone` string
  - `picture` object
    - `thumbnail` string, required
    - `regular` string, required
    - `large` string, required
  - `tags` string[]
  - `phone` string
  - `phones` string[]
  - `preferredContactMethod` string
  - `noteBeforeContacting` string
  - `notes` string
  - `customerType` 'lite' | 'pro'
  - `favs` object
    - `views` string[], required
  - `displayLanguage` string
  - `settings` object
    - `notifications` object — Notification settings
      - `subscriptions` object[], required
        - `type` 'PAYMENT' | 'RESERVATION' | 'TASK' | 'GENERAL' | 'NIGHTS_LIMIT' | 'PROPERTY', required
        - `name` string, required
        - `targets` string[], required
  - `registrationType` string
  - `registrationOrigin` 'SALESFORCE'
  - `country` 'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BH' | 'BS' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MK' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' — Country code (ISO 2-letter). Undefined by default unless set by user.
  - `roles` object[] — Deprecated: please follow the instructions in [the description](#/Users/createUser) for more details about the role assignment workflow.
    - `roleId` '57447a900ebc04ba98064035' | '58db6932ea2a13ea9f4855a5' | '578b52a6dddfe2b1d0781b0e' | '578b52a6dddfe2b1d0781b0f' | '578b52a6dddfe2b1d0781b12' | '578b52a6dddfe2b1d0781b10' | '578b52a6dddfe2b1d0781b11' | '57c2d040cf6c3fed6a4d1775' | '58db693fea2a13ea9f4855aa' | '579e1769cf6c3fed6a3f6b1a' | '5e567a850ba1fb0244146fc0' | '5e57b0826b4440002a603a93' | '60d1b0fb396b25993e756e63' | '5cf7846e02d9171c4e4b1698', required — Role ID: * `58db6932ea2a13ea9f4855a5` - Account manager * `578b52a6dddfe2b1d0781b0e` - Listing Viewer * `578b52a6dddfe2b1d0781b0f` - Calendar Availability Control * `578b52a6dddfe2b1d0781b12` - Listing Admin * `578b52a6dddfe2b1d0781b10` - Calendar Full Control * `578b52a6dddfe2b1d0781b11` - Listing's Financials * `57447a900ebc04ba98064035` - Account admin * `57c2d040cf6c3fed6a4d1775` - Integration Manager * `58db693fea2a13ea9f4855aa` - Viewer * `579e1769cf6c3fed6a3f6b1a` - Listing Manager * `5e567a850ba1fb0244146fc0` - Calendar Viewer * `5e57b0826b4440002a603a93` - Communication Agent * `60d1b0fb396b25993e756e63` - Revenue Manager
    - `listingIds` string[]

## Response `201`

Success response

- object
  - `_id` string — User MongoDB _id
  - `accountId` string — Your account ID
  - `email` string
  - `emails` string[]
  - `firstName` string
  - `userStartedUpdateEmailFlow` boolean
  - `lastName` string
  - `fullName` string
  - `title` string
  - `timezone` string
  - `picture` object
    - `thumbnail` string, required
    - `regular` string, required
    - `large` string, required
  - `tags` string[]
  - `lastActivityTime` number
  - `phone` string
  - `phones` string[]
  - `preferredContactMethod` string
  - `noteBeforeContacting` string
  - `notes` string
  - `favs` object
    - `views` string[], required
  - `displayLanguage` string
  - `settings` object
    - `notifications` object — Notification settings
      - `subscriptions` object[], required
        - `type` 'PAYMENT' | 'RESERVATION' | 'TASK' | 'GENERAL' | 'NIGHTS_LIMIT' | 'PROPERTY', required
        - `name` string, required
        - `targets` string[], required
  - `roles` object[] — Deprecated: Roles field is optional and may not be present for users created in the new flow.
    - `roleId` string, required — Role ID: * `58db6932ea2a13ea9f4855a5` - Account manager * `578b52a6dddfe2b1d0781b0e` - Listing Viewer * `578b52a6dddfe2b1d0781b0f` - Calendar Availability Control * `578b52a6dddfe2b1d0781b12` - Listing Admin * `578b52a6dddfe2b1d0781b10` - Calendar Full Control * `578b52a6dddfe2b1d0781b11` - Listing's Financials * `57447a900ebc04ba98064035` - Account admin * `57c2d040cf6c3fed6a4d1775` - Integration Manager * `58db693fea2a13ea9f4855aa` - Viewer * `579e1769cf6c3fed6a3f6b1a` - Listing Manager * `5e567a850ba1fb0244146fc0` - Calendar Viewer * `5e57b0826b4440002a603a93` - Communication Agent * `60d1b0fb396b25993e756e63` - Revenue Manager
    - `listingIds` string[]

## Other responses

- `400` — Bad request

---

[API](https://skmtc.net/guesty/apis/guesty-open-api.md) · [All operations](https://skmtc.net/guesty/apis/guesty-open-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/guesty/guesty-open-api/revisions/7c62644070f2/schema)