API Reference

Update user (all fields)

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

This API allows you to update a user by ID (all fields required)

Path Params
uuid
required

The ID of the user to update

Body Params

The user object to update Note: if birthDate is provided, birthDayDay and birthDayMonth are not required and vice versa. Listed below are 2 kind of payloads:

  1. birthDate is provided
  2. birthDayDay and birthDayMonth are provided
string
required

User's birth date YYYY-MM-DD or MM-DD format

string
required

User's username

string
enum
required

User's status

Allowed:
string
required

User's first name

string
required

User's last name

string
required

User's pronouns

string
required

URL to the user's pronunciation

string
required

User's email address

string
required

User's mobile phone number

string
required

User's phone number

string
required

User's extension

string
required

User's about

string
required

URL to the user's photo

string
required

User's employee number

string
required

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
required

User's people category

string
required

User's timezone

string
required

User's locale

string
required

User's manager id

string
required

User's assistant id

boolean
required

Whether the user's assistant email is displayable

boolean
required

Whether the user's assistant mobile is displayable

boolean
required

Whether the user's assistant phone is displayable

string
required

User's zoom url

string
required

User's skype url

string
required

User's linkedin url

string
required

User's twitter url

string
required

User's facebook url

string
required

User's youtube url

string
required

User's instagram url

string
enum
required

User's pay currency

string
required

User's license type

string
required

User's address line 1

string
required

User's address line 2

string
required

User's city

string
required

User's state

string
required

User's postal code

string
required

User's country

string
required

User's title

string
required

User's department

string
required

User's division

string
required

User's business unit

string
required

User's company name

string
required

User's start date

string
required

User's user type

required

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

required

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 about 1 month ago

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 about 1 month ago