Skip to content
API Reference
/
/
Update a User Based on ID

Update a User Based on ID

Request

Update a User based on ID. It returns the updated User.

Security
api_key
Path
idstringrequired

Unique identifier of the User

Headers
x-managed-company-idstringrequired

The ID of the managed company on behalf of which the request is made

Bodyapplication/jsonrequired
rolestring

Role of the user

Enum:"CLIENT_VIEWER""CLIENT_OPERATOR""CLIENT_DEPARTMENT_ADMIN""CLIENT_ADMIN"
departmentsArray of strings

Departments associated with the user

firstNamestring

First name of the user

lastNamestring

Last name of the user

preferredLanguagestring

Preferred language of the user

Enum:"EN""NL""FR"
enabledboolean

Indicates if the user in enabled

hasQERDSMandateboolean
curl -i -X PATCH \
  'https://doc.acc.connect.easypost.eu/_mock/public-api/openapi/users/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-managed-company-id: string' \
  -d '{
    "role": "CLIENT_VIEWER",
    "departments": [
      "string"
    ],
    "firstName": "string",
    "lastName": "string",
    "preferredLanguage": "EN",
    "enabled": true,
    "hasQERDSMandate": true
  }'

Responses

Bodyapplication/json
idstringrequired

Unique identifier of the user

companyIdstringrequired

Unique identifier of the company

usernamestringrequired

Username of the user

rolestringrequired

Role of the user

Enum:"CLIENT_VIEWER""CLIENT_OPERATOR""CLIENT_DEPARTMENT_ADMIN""CLIENT_ADMIN"
departmentsArray of stringsrequired

Departments associated with the user

firstNamestringrequired

First name of the user

lastNamestringrequired

Last name of the user

preferredLanguagestringrequired

Preferred language of the user

Enum:"EN""NL""FR"
emailAddressstring, (email)required

Email address of the user

hasMFALoginEnabledbooleanrequired

Indicates if MFA login is enabled for the user

hasQERDSMandatebooleanrequired

Indicates if QERDS mandate is enabled for the user

enabledbooleanrequired

Indicates if the user is enabled

createdAtstringrequired

Creation date of the user

lastModifiedAtstringrequired

Last modification date of the user

lastModifiedBystringrequired

Last modified by information

Response
{
  "id": "string",
  "companyId": "string",
  "username": "string",
  "role": "CLIENT_VIEWER",
  "departments": [
    "string"
  ],
  "firstName": "string",
  "lastName": "string",
  "preferredLanguage": "EN",
  "emailAddress": "user@example.com",
  "hasMFALoginEnabled": true,
  "hasQERDSMandate": true,
  "enabled": true,
  "createdAt": "string",
  "lastModifiedAt": "string",
  "lastModifiedBy": "string"
}