Replace an existing User resource with a new one

put

https://example.com/v3/suite/users({userIdentifier})

Fully replaces an existing user identified by the userIdentifier. Any fields not provided in the request will be set to null or their default values.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

userIdentifier

string

required

An identifier string. Supported formats:

Raw ID: Pass the ID (guid) directly (e.g., b48737b7-62ac-421b-9c12-3c1014dd07b7)
Explicit ID: Key-value pair (e.g., id=b48737b7-62ac-421b-9c12-3c1014dd07b7)
Username: Key-value pair (e.g., username=jdoe)
Import Key: Key-value pair (e.g., importkey=imp_A123)

Body Params

username

string

required

givenName

string

familyName

string

preferredName

string

dateOfBirth

date

Date of birth in YYYY-MM-DD format

emailAddress

string

ccEmailAddress

string

mobileNumber

string

culture

string

department

string

division

string

companyName

string

managerType

string

preferredTrainingLocation

string

location

string

region

string

costCenter

string

payGrade

string

payrollNumber

string

contractType

string

employeeCategory

string

isEnabled

boolean

enabledProducts

object

startDate

date

Start date of employment in YYYY-MM-DD format

leaveDate

date

End date of employment in YYYY-MM-DD format

isAbsent

boolean

isFireWarden

boolean

isFirstAider

boolean

importKey

string

customFields

object

Custom fields dictionary

Responses

204

User replaced successfully

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/problem+json

400Bad Request

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found

500Internal Server Error