Skip to content
API Reference/
/
Create a User

Create a User

Request

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

Security
X-API-KEY or Authorization
Bodyapplication/json

User data to be created

emailstringrequired

Email

passwordstring

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

idinteger, (int64)

The uberall unique id for the user

salutationstring

One of MALE, FEMALE or OTHER

firstnamestringrequired

First Name

lastnamestringrequired

Last name

phonestring

The user's phone number

statusstring

The status of the current user. One of CREATED, VERIFIED, UNVERIFIED, INVITED, INACTIVE, NO_LOGIN

Enum:"INVITED""CREATED""VERIFIED""UNVERIFIED""INACTIVE""DELETED""NO_LOGIN"
rolestringrequired

User Role

Enum:"UBER_API_ADMIN""API_ADMIN""ADMIN""ACCOUNT_MANAGER""BUSINESS_MANAGER""LOCATION_MANAGER""BUSINESS_MANAGER_INBOX"
salesPartnerobject

The "Sales Partner" this user belongs to

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

featuresArray of strings, unique

A list of features this user can work with. Values:

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
Items Enum:"ADS""ADS_READ""ADS_WRITE""ADVANCED_ANALYTICS_2_0""AI_KNOWLEDGEBASE""AI_LOCALISATION""AI_LOCATION_INFORMATION""AI_SUGGESTED_REPLIES""APPLE_POSTING""APPLE_POSTING_WRITE"
emailSettingsArray of objects, unique

A list of EmailSettings for this user. Only one EmailSettings object per EmailType possible.

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:


"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"
      ]
   '}'
'}'
whitelabelInformationobject

Whitelabel Information Model

rolesArray of strings

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

locationGroupIdsArray of integers, (int64)

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

managedLocationsViaGroupsArray of integers, (int64)

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

dateCreatedstring, (date-time)
managedBusinessesArray of integers, (int64)

A list of businesses managed by this user

managedLocationsArray of integers, (int64)

A list of locations managed by this user

connectedAccountsArray of strings
paymentMethodArray of strings
showSpSwitchboolean
isParentboolean
canManageLocationGroupsboolean
multiFactorAuthenticationsArray of objects, unique
managedLocationsIdentifiersArray of integers, (int64)
curl -i -X POST \
  https://uberall.com/api/users \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "email": "string",
    "password": "string",
    "id": 0,
    "salutation": "string",
    "firstname": "string",
    "lastname": "string",
    "phone": "string",
    "status": "INVITED",
    "role": "UBER_API_ADMIN",
    "salesPartner": {
      "id": 0,
      "aggregateInvoicesToParent": true,
      "attribution": {
        "name": "string",
        "url": "string",
        "id": 0,
        "logo": {
          "url": "string",
          "type": "LOGO",
          "description": "string"
        }
      },
      "canSeePrices": true,
      "emailCustomerSupport": "string",
      "emailProjectLead": "string",
      "forceSso": true,
      "identifier": "string",
      "minPasswordLength": 0,
      "name": "string",
      "phone": "string",
      "preferredLanguage": "string",
      "pushUrl": "string",
      "salesPartnerStatus": "CREATED",
      "subscribedWebhookEventTypes": [
        "ADMIN_ALERT"
      ],
      "whitelistedRedirectUrls": [
        "string"
      ],
      "currency": "string",
      "entity": "UBERALL_BV",
      "isSsoActive": true,
      "maxFreeLocations": 0,
      "type": "string",
      "whitelabelInformations": [
        {
          "id": 0,
          "name": "string",
          "identifier": "string"
        }
      ],
      "onboardingStatus": "NOT_STARTED",
      "country": "AF",
      "locationGroupIds": [
        0
      ],
      "address": "string",
      "contactPerson": 0,
      "emailAccounting": "string",
      "vatId": "string",
      "parentId": 0,
      "price": 0,
      "priceMin": 0,
      "commission": 0
    },
    "preferredLanguage": "string",
    "identifier": "string",
    "features": [
      "ADS"
    ],
    "emailSettings": [
      {
        "frequency": "ALWAYS",
        "emailType": "DIGEST",
        "id": 0
      }
    ],
    "featuresDetailed": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "whitelabelInformation": {
      "id": 0,
      "name": "string",
      "identifier": "string"
    },
    "roles": [
      "UBER_API_ADMIN"
    ],
    "locationGroupIds": [
      0
    ],
    "managedLocationsViaGroups": [
      0
    ],
    "dateCreated": "2019-08-24T14:15:22Z",
    "managedBusinesses": [
      0
    ],
    "managedLocations": [
      0
    ],
    "connectedAccounts": [
      "string"
    ],
    "paymentMethod": [
      "string"
    ],
    "showSpSwitch": true,
    "isParent": true,
    "canManageLocationGroups": true,
    "multiFactorAuthentications": [
      {
        "email": "string",
        "type": "EMAIL",
        "id": 0
      }
    ],
    "managedLocationsIdentifiers": [
      0
    ]
  }'

Responses

Successfully created user

Body*/*
statusstringrequired
Enum:"SUCCESS""PENDING""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

Response
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "user": {
      "email": "string",
      "password": "string",
      "id": 0,
      "salutation": "string",
      "firstname": "string",
      "lastname": "string",
      "phone": "string",
      "status": "INVITED",
      "role": "UBER_API_ADMIN",
      "salesPartner": {
        "id": 0,
        "aggregateInvoicesToParent": true,
        "attribution": {
          "name": "string",
          "url": "string",
          "id": 0,
          "logo": {
            "url": "string",
            "type": "LOGO",
            "description": "string"
          }
        },
        "canSeePrices": true,
        "emailCustomerSupport": "string",
        "emailProjectLead": "string",
        "forceSso": true,
        "identifier": "string",
        "minPasswordLength": 0,
        "name": "string",
        "phone": "string",
        "preferredLanguage": "string",
        "pushUrl": "string",
        "salesPartnerStatus": "CREATED",
        "subscribedWebhookEventTypes": [
          "ADMIN_ALERT"
        ],
        "whitelistedRedirectUrls": [
          "string"
        ],
        "currency": "string",
        "entity": "UBERALL_BV",
        "isSsoActive": true,
        "maxFreeLocations": 0,
        "type": "string",
        "whitelabelInformations": [
          {
            "id": 0,
            "name": "string",
            "identifier": "string"
          }
        ],
        "onboardingStatus": "NOT_STARTED",
        "country": "AF",
        "locationGroupIds": [
          0
        ],
        "address": "string",
        "contactPerson": 0,
        "emailAccounting": "string",
        "vatId": "string",
        "parentId": 0,
        "price": 0,
        "priceMin": 0,
        "commission": 0
      },
      "preferredLanguage": "string",
      "identifier": "string",
      "features": [
        "ADS"
      ],
      "emailSettings": [
        {
          "frequency": "ALWAYS",
          "emailType": "DIGEST",
          "id": 0
        }
      ],
      "featuresDetailed": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      },
      "whitelabelInformation": {
        "id": 0,
        "name": "string",
        "identifier": "string"
      },
      "roles": [
        "UBER_API_ADMIN"
      ],
      "locationGroupIds": [
        0
      ],
      "managedLocationsViaGroups": [
        0
      ],
      "dateCreated": "2019-08-24T14:15:22Z",
      "managedBusinesses": [
        0
      ],
      "managedLocations": [
        0
      ],
      "connectedAccounts": [
        "string"
      ],
      "paymentMethod": [
        "string"
      ],
      "showSpSwitch": true,
      "isParent": true,
      "canManageLocationGroups": true,
      "multiFactorAuthentications": [
        {
          "email": "string",
          "type": "EMAIL",
          "id": 0
        }
      ],
      "managedLocationsIdentifiers": [
        0
      ]
    },
    "usersLeft": 1
  }
}