v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Users

Update a user

Updates user information. At least one field must be provided. Required scope: users:write </br>Organization authorization: supported

patch/api/v1/users/{userId}

Path parameters

userIdinteger required

Request body

emailstring email nullable

User email address

phonestring nullable

User phone number in E.164 format

firstNamestring nullable

User first name

lastNamestring nullable

User last name

languagestring nullable

User preferred language

legalEmailstring email nullable

User legal email address

address1string nullable

User address line 1

address2string nullable

User address line 2

address3string nullable

User address line 3

zipstring nullable

User zip/postal code

citystring nullable

User city

provincestring nullable

User province/state

Example request

{
  "email": "user@example.com",
  "phone": "+4512345678",
  "firstName": "John",
  "lastName": "Doe",
  "language": "en",
  "legalEmail": "legal@example.com",
  "address1": "Strandboulevarden 122",
  "address2": "Apt 4B",
  "address3": "5. sal",
  "zip": "2100",
  "city": "Copenhagen",
  "province": "Capital Region"
}

Response

User updated

idinteger required

Id of the user

firstNamestring nullable

First name of the user

lastNamestring nullable

Last name of the user

emailstring nullable

Email of the user

legalEmailstring nullable

Legal email of the user (certified e-mail)

phonestring nullable

Phone number of the user

profileImageUrlstring nullable

URL of the profile image

languagestring nullable

Preferred language of the user

termsReadAtstring date-time nullable

Timestamp when the user read the terms

taxIdentificationNumberstring nullable

Personal tax number if set for the user

vatNumberstring nullable

VAT number which is the company tax id

recipientCodestring nullable

The recipient code used for e-invoicing

createdAtstring date-time nullable

Timestamp when the user was created

updatedAtstring date-time nullable

Timestamp when the user was last updated

deletedAtstring date-time nullable

Timestamp when the user was deleted

emailVerifiedAtstring date-time nullable

Timestamp when the email was verified

phoneVerifiedAtstring date-time nullable

Timestamp when the phone was verified

marketingEmailsAcceptedAtstring date-time nullable

Timestamp when the user accepted the marketing emails

defaultTeamIdinteger nullable

ID of the default team for the user

isGuestboolean nullable

Indicates whether this user is a guest (ad-hoc) user who has not yet completed registration

nationalIdstring nullable

National identification number. Returned only when configured per operator

Example response

{
  "id": 10,
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "legalEmail": "legal@ut.com",
  "phone": "+1234567890",
  "profileImageUrl": "https://example.com/profile.jpg",
  "address": {
    "address1": "Strandboulevarden 122",
    "address2": "København",
    "address3": "5. sal",
    "zip": "2100",
    "city": "Copenhagen",
    "province": "Lombardy",
    "country": "Denmark",
    "countryAreaId": 1
  },
  "language": "en",
  "termsReadAt": "2023-06-21T15:03:14Z",
  "taxIdentificationNumber": "X12345678A",
  "vatNumber": " IT07643520567",
  "recipientCode": "2021-10-001",
  "createdAt": "2023-06-21T15:03:14Z",
  "updatedAt": "2023-06-21T15:03:14Z",
  "deletedAt": "2023-06-21T15:03:14Z",
  "emailVerifiedAt": "2023-06-21T15:03:14Z",
  "phoneVerifiedAt": "2023-06-21T15:03:14Z",
  "marketingEmailsAcceptedAt": "2023-06-21T15:03:14Z",
  "defaultTeamId": 10,
  "nationalId": "123456-7890"
}