Skip to content
API Reference/
/
Update a User

Update a User

Request

Edit an existing user

Security
X-API-KEY or Authorization
Path
idstringrequired

User ID

curl -i -X PATCH \
  'https://uberall.com/api/users/{id}' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully edited 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",
        "locationGroupIds": [
          0
        ],
        "country": "AF",
        "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
      ]
    }
  }
}