API Reference

Update user (delta update)

patch
https://{endpoint}/v1/b2b/identity/users/

This api allows you to update a user by ID (delta update) i.e. only the fields provided in the request body will be updated.
To clear value explicitly pass null.

Path Params
uuid
required

The ID of the user to update

Body Params

Update user request

string

User's username

string
enum

User's status

Allowed:
string

User's first name

string

User's last name

string

User's pronouns

string

URL to the user's pronunciation

string

User's email address

string

User's mobile phone number

string

User's phone number

string

User's extension

string

User's about

string

URL to the user's photo

string

User's employee number

string

URL to the user's cover image

uuid

File id of the user's photo

uuid

File id of the user's cover image

string

User's people category

string

User's timezone

string

User's locale

string

User's manager id

string

User's assistant id

boolean

Whether the user's assistant email is displayable

boolean

Whether the user's assistant mobile is displayable

boolean

Whether the user's assistant phone is displayable

string

User's zoom url

string

User's skype url

string

User's linkedin url

string

User's twitter url

string

User's facebook url

string

User's youtube url

string

User's instagram url

string
enum

User's pay currency

string

User's license type

string

User's address line 1

string

User's address line 2

string

User's city

string

User's state

string

User's postal code

string

User's country

string

User's title

string

User's department

string

User's division

string

User's business unit

string

User's company name

string

User's start date

string

User's user type

User's custom fields (if applicable) (pass it as string if custom field types is not enabled)
For multi-select custom fields, pass it as an array of strings or as a string with semicolons (;) separated values
For date custom fields, pass it as a string in YYYY-MM-DD format

User's custom fields (if applicable) (pass it as string if custom field types is not enabled)
For multi-select custom fields, pass it as an array of strings or as a string with semicolons (;) separated values
For date custom fields, pass it as a string in YYYY-MM-DD format

Responses
204

User updated successfully

Updated 2 months ago

Did this page help you?
Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?