Sign in

v1

latestOpenAPI 3.0.1Licensed under Uberall2026-08-0629353914.0 MB
Users

Create a User

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

post/users

Request body

emailstring required

Email

passwordstring

The user's password. Only for POST requests. Don't use when creating a user with status INVITED!

idinteger

The uberall unique id for the user

salutationstring

One of MALE, FEMALE or OTHER

firstnamestring required

First Name

lastnamestring required

Last name

phonestring

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

preferredLanguagestring

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.

identifierstring

The unique user identifier based on your internal identification system

featuresstring[]

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>
featuresDetailedobject

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>
rolesstring[]

The user's role. One of ADMIN, BUSINESS_MANAGER, MULTI_BUSINESS_MANAGER, LOCATION_MANAGER.

locationGroupIdsinteger[]

A list of all location group IDs the user is assigned to.

managedLocationsViaGroupsinteger[]

A list of all location IDs the user can manage because of assignment to certain group(s)

dateCreatedstring date-time
managedBusinessesinteger[]

A list of businesses managed by this user

managedLocationsinteger[]

A list of locations managed by this user

connectedAccountsstring[]
paymentMethodstring[]
showSpSwitchboolean
isParentboolean
canManageLocationGroupsboolean
managedLocationsIdentifiersinteger[]

Example request

{
  "salesPartner": {
    "attribution": {
      "logo": {
        "type": "LOGO"
      }
    }
  }
}

Response

Successfully created user