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

# Create a User

`POST /users`

Create a new user, subject to throttling of 10 creations per 10 seconds.

## Request body

- object — User Model
  - `email` string, required — Email
  - `password` string — The user's password. Only for POST requests. Don't use when creating a user with status INVITED!
  - `id` integer — The uberall unique id for the user
  - `salutation` string — One of MALE, FEMALE or OTHER
  - `firstname` string, required — First Name
  - `lastname` string, required — Last name
  - `phone` string — The user's phone number
  - `status` 'INVITED' | 'CREATED' | 'VERIFIED' | 'UNVERIFIED' | 'INACTIVE' | 'DELETED' | 'NO_LOGIN' — The status of the current user. One of CREATED, VERIFIED, UNVERIFIED, INVITED, INACTIVE, NO_LOGIN
  - `role` 'UBER_API_ADMIN' | 'API_ADMIN' | 'ADMIN' | 'ACCOUNT_MANAGER' | 'BUSINESS_MANAGER' | 'LOCATION_MANAGER' | 'BUSINESS_MANAGER_INBOX', required — User Role
  - `salesPartner` object — The "Sales Partner" this user belongs to
    - `id` integer — The uberall sales partner id
    - `aggregateInvoicesToParent` boolean — (only used for child SalesPartner) Indicates if the invoice for this SalesPartner should be aggregated to the parent invoice
    - `attribution` object — Attribution details of the SalesPartner
      - `name` string, required — Name of the attribution
      - `url` string, required — URL the attribution should point to
      - `id` integer
      - `logo` object — Logo details model
        - `url` string, required — Url pointing to the attribution logo
        - `type` string — Type
        - `description` string — Description of the logo
    - `canSeePrices` boolean — Indicates if the SalesPartner should be allowed to see price information for e.g. product plans
    - `emailCustomerSupport` string — Customer support email of the SalesPartner
    - `emailProjectLead` string — Project lead email of the SalesPartner
    - `forceSso` boolean — If set to true, all users of this SalesPartner will only be allowed to log in our app via the SSO flow. Users cannot be created or updated directly - only via SSO. If set to false and "isSsoActive" is set, users can either log in via normal login or SSO
    - `identifier` string — Identifier for SalesPartner, must be unique for child SalesPartner within parent SalesPartner
    - `minPasswordLength` integer — Minimum password length
    - `name` string — The name
    - `phone` string — The phone number
    - `preferredLanguage` string — Preferred language of the SalesPartner, for invoice purpose (either 'de' or 'en')
    - `pushUrl` string — URL where selected webhook events should be sent to
    - `salesPartnerStatus` 'CREATED' | 'APPROVED' | 'DECLINED' | 'DELETED' | 'INACTIVE' — SalesPartner status of the SalesPartner (Be aware: Only sending 'INACTIVE' for child SalesPartner update is allowed)
    - `subscribedWebhookEventTypes` string[] — List of all event types the SalesPartner want to receive push messages for via webhook functionality, for a list of all possible types use the GET /api/salespartners/subscribable-event-types endpoint
    - `whitelistedRedirectUrls` string[] — Domains that are allowed to be redirected to upon finalizing a directory connect flow
    - `currency` string — The currency
    - `entity` 'UBERALL_BV' | 'UBERALL_CANADA_INC' | 'UBERALL_FR' | 'UBERALL_GMBH' | 'UBERALL_INC' | 'UBERALL_MF' | 'UBERALL_UK' — Uberall entity
    - `isSsoActive` boolean — If set to true this will activate the single sign-on flow for logging into our app. Note that all more details need to be set before it can be used.
    - `maxFreeLocations` integer — Max free locations
    - `type` string — The type, e.g. STANDARD or CUSTOM
    - `whitelabelInformations` object[] — List of the sales partner's white-label information
      - `id` integer — id
      - `name` string — Name of white-label information
      - `identifier` string — Url path of the white-label information
    - `onboardingStatus` 'NOT_STARTED' | 'IN_PROGRESS' | 'FINISHED' | 'ABORTED' — The onboarding status of the SalesPartner
    - `locationGroupIds` integer[]
    - `country` 'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | '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' | 'XK' | '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' | 'UK' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' — The country
    - `address` string — Full address field including street, zip and city.
    - `contactPerson` integer — The contact person
    - `emailAccounting` string — Accounting email of the SalesPartner
    - `vatId` string
    - `parentId` integer
    - `price` integer
    - `priceMin` integer
    - `commission` integer
  - `preferredLanguage` string — Preferred language of a user. If not set, this will default to the language in context, e.g., location's for e-mails and browser language for our applications.
  - `identifier` string — The unique user identifier based on your internal identification system
  - `features` string[] — A list of features this user can work with. Values: <pre>ADS_READ ADS_WRITE ADVANCED_ANALYTICS AI_SUGGESTED_REPLIES AI_BULK_REPLIES APPLE_POSTING_WRITE AUTO_RESPONSE_WRITE BULK_UPDATES BUSINESS_LEVEL_CONNECT CAN_PAY_INVOICE CAN_SEE_HELP_SECTION CHAT_READ CHAT_WRITE CHATBOT_READ CHATBOT_WRITE DAM ENTERPRISE_ONBOARDING FIRST_PARTY_REVIEW_APPROVAL FORMS INBOX_2_0_BETA_READ INBOX_2_0_BETA_WRITE INBOX_APPROVAL INBOX_READ INBOX_WRITE INSTAGRAM_POSTING_WRITE LISTINGS_PAGE_NEW LISTINGS LIVE_CHAT LOCATION_GROUP LOCATION_READ LOCATION_SCHEDULED_UPDATES LOCATION_STATUS_CHANGE LOCATION_WRITE POSTING_APPROVAL POSTING_READ POSTING_WRITE PRICE_INFO RESPONSE_LIBRARY_READ RESPONSE_LIBRARY_WRITE REVIEW_GENERATION_CREATE REVIEW_GENERATION_SEND SINGLE_SIGN_ON SOCIAL_ADS SUPPRESSION TRACKING UPGRADE USER_OTHERS_EDIT USER_SELF_EDIT</pre>
  - `emailSettings` object[] — A list of EmailSettings for this user. Only one EmailSettings object per EmailType possible.
    - `frequency` 'ALWAYS' | 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'NEVER' — Frequency of the emailType. The available frequencies by email type are: DIGEST: WEEKLY, MONTHLY or NEVER; ACTIVATION: ALWAYS or NEVER; START_VERIFICATION_GOOGLE: ALWAYS or NEVER; FINISH_VERIFICATION_GOOGLE: ALWAYS or NEVER; UNREAD_REVIEW_NOTIFICATION: ALWAYS or NEVER; PENDING_APPROVAL_REPLY_NOTIFICATION: DAILY, ALWAYS or NEVER.
    - `emailType` 'DIGEST' | 'UNREAD_REVIEW_NOTIFICATION' | 'PENDING_APPROVAL_REPLY_NOTIFICATION' | 'ACTIVATION' | 'START_VERIFICATION_GOOGLE' | 'FINISH_VERIFICATION_GOOGLE' | 'NEW_CHATS_NOTIFICATION' | 'NEW_CONTACT_FORM_NOTIFICATION' | 'SOCIAL_POST_PENDING_APPROVAL_NOTIFICATION' | 'DASHBOARD_EXPORT' | 'RENEWAL_FAIL' | 'RENEWAL_SUCCESS' | 'RESET_PASSWORD_SP' | 'SALES_PARTNER_APPROVAL' | 'USER_INVITATION' | 'SALES_PARTNER_ENTERPRISE_ONBOARDING_COMPLETE' | 'NEW_CHAT_NOTIFICATION_LOCATION' | 'NEW_CHAT_NOTIFICATION_BUSINESS' | 'NEW_CONTACT_FORM_NOTIFICATION_LOCATION' | 'NEW_CONTACT_FORM_NOTIFICATION_BUSINESS' | 'INVOICE_CREATED_RENEWAL' | 'INTERNAL' | 'TIMELY_TASK_NOTIFICATION_1' | 'TIMELY_TASK_NOTIFICATION_2' | 'TIMELY_TASK_NOTIFICATION_3' | 'LOCATION_CLEANSING_FAILED_NOTIFICATION' — Type of email. Currently, the types of email supported are: DIGEST, ACTIVATION, START_VERIFICATION_GOOGLE, FINISH_VERIFICATION_GOOGLE, UNREAD_REVIEW_NOTIFICATION, PENDING_APPROVAL_REPLY_NOTIFICATION, SOCIAL_POST_PENDING_APPROVAL_NOTIFICATION, NEW_CHATS_NOTIFICATION, NEW_CONTACT_FORM_NOTIFICATION
    - `id` integer
  - `featuresDetailed` object — Map containing the feature names and corresponding feature-specific parameters. "featuresDetailed" is supported for the features LOCATION_WRITE and ADVANCED_ANALYTICS. For LOCATION_WRITE a list of fields that this user can update is expected. For ADVANCED_ANALYTICS a list of dashboards the user has access to is expected. For example: <pre> "featuresDetailed": '{' '{' "featuresDetailed":'{' "LOCATION_WRITE":[ "fax", "openingHours", "callTrackingNumbers", "streetNo", "openingHoursNotes", "specialOpeningHours", "street", "languages", "customFields", "contentLists", "photos", "services", "moreHours", "descriptionLong", "zip", "lat", "openingDate", "email", "addressDisplay", "labels", "taxNumber", "city", "cellphone", "contentCollections", "attributes", "categories", "imprint", "phone", "utms", "addressExtra", "keywords", "legalIdent", "lng", "paymentOptions", "descriptionShort", "socialProfiles", "identifier", "website", "country", "province", "name", "videos", "brands", "serviceAreas" ], "ADVANCED_ANALYTICS":[ "overview", "listings-google", "customer-feedback" ] '}' '}' </pre>
  - `whitelabelInformation` object — Whitelabel Information Model
    - `id` integer — id
    - `name` string — Name of white-label information
    - `identifier` string — Url path of the white-label information
  - `roles` string[] — The user's role. One of ADMIN, BUSINESS_MANAGER, MULTI_BUSINESS_MANAGER, LOCATION_MANAGER.
  - `locationGroupIds` integer[] — A list of all location group IDs the user is assigned to.
  - `managedLocationsViaGroups` integer[] — A list of all location IDs the user can manage because of assignment to certain group(s)
  - `dateCreated` string, date-time
  - `managedBusinesses` integer[] — A list of businesses managed by this user
  - `managedLocations` integer[] — A list of locations managed by this user
  - `connectedAccounts` string[]
  - `paymentMethod` string[]
  - `showSpSwitch` boolean
  - `isParent` boolean
  - `canManageLocationGroups` boolean
  - `multiFactorAuthentications` object[]
    - `email` string — Email
    - `type` 'EMAIL' — Multi factor authentication type
    - `id` integer
  - `managedLocationsIdentifiers` integer[]

## Response `200`

Successfully created user

## Other responses

- `400` — Bad Request - The request was invalid or cannot be otherwise served
- `401` — Unauthorized - Authentication credentials are missing or invalid
- `403` — Forbidden - The request is understood, but has been refused or access is not allowed
- `404` — Not Found - The requested resource could not be found
- `409` — Conflict - The request conflicts with current state of the server

---

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