Users
Update User
Update a User
patch/api/v1/users/{id}
Path parameters
idstring uuid required
Example:69ae0e64b02bfe73a44ca479
Request body
Example request
{
"data": {
"attributes": {
"email": "testing@example.com",
"work_email": "testing@example.com",
"first_name": "Daniel",
"last_name": "Smith",
"middle_name": "Jones",
"start_date": "2026-01-01",
"employee_type": "Regular",
"candidate_status": "offer_accepted",
"legal_entity": "Xpand Limited",
"cost_center_id": "Cost Center",
"relocation_type": "global_relocation",
"reason_blocked": "Inactive in ATS System",
"external_ids": {
"ats_id": "A-1234",
"hris_id": "E-1234"
},
"office_location_id": {
"workday": "LOCATION-3-69"
},
"recruiter_ids": {
"recruiter": {
"hris_id": "R-1111"
},
"recruiting_coordinator": {
"hris_id": "R-2222"
},
"recruiting_manager": {
"hris_id": "R-3333"
}
},
"manager_ids": {
"hris_id": [
"M-1111",
"M-2222"
]
},
"documents": [
{
"document_type": "offer_letter",
"document_number": "1234",
"document_title": "Offer Letter",
"document_description": "Offer Letter to the Joe",
"issuer": "Issuer",
"issuer_city": "New York",
"issuer_state": "New York",
"issuer_country": "USA",
"issued_date": "2026-01-01",
"expiry_date": "2026-01-01",
"attachments": [
{
"file_name": "abc.pdf",
"file_content_base64": "WW91J3JlIGEgY3VyaW91cyBmZWxsb3cgOy0p",
"responses": {
"field_name_1": "abc",
"field_name_2": "cba"
}
}
]
}
],
"educations": [
{
"school_name": "School Name",
"degree": "Degree",
"student_id": "1001",
"time_type": "Full Time",
"major": "Communications",
"minor": "Publications",
"gpa": 4,
"specialization": "IT",
"graduation_date": "2026-01-01",
"grade": "A",
"name_while_attending": "Jon Doe",
"start_date": "2026-01-01",
"end_date": "2026-01-01",
"address": {
"line_1": "31 St, 34 West",
"line_2": "8th Avenue",
"city": "New York",
"state": "New York",
"postal_code": "100018",
"country": "USA",
"current": true,
"permanent": true,
"start_date": "2026-01-01",
"end_date": "2026-01-01"
},
"attachments": [
{
"file_name": "abc.pdf",
"file_content_base64": "WW91J3JlIGEgY3VyaW91cyBmZWxsb3cgOy0p",
"responses": {
"field_name_1": "abc",
"field_name_2": "cba"
}
}
]
}
],
"work_experiences": [
{
"employer": "Employer",
"employee_id": "E1234",
"current": true,
"job_title": "Engineer",
"department": "Department",
"employment_type": "Regular",
"reason_for_leaving": "Change in technology",
"salary": 10000,
"manager_name": "Manager 1",
"manager_phone": "+14044578776",
"manager_email": "testing@example.com",
"hr_name": "HR 1",
"hr_phone": "+14044578777",
"hr_email": "testing@example.com",
"start_date": "2026-01-01",
"end_date": "2026-01-01",
"address": {
"line_1": "31 St, 34 West",
"line_2": "8th Avenue",
"city": "New York",
"state": "New York",
"postal_code": "100018",
"country": "USA",
"current": true,
"permanent": true,
"start_date": "2026-01-01",
"end_date": "2026-01-01"
},
"attachments": [
{
"file_name": "abc.pdf",
"file_content_base64": "WW91J3JlIGEgY3VyaW91cyBmZWxsb3cgOy0p",
"responses": {
"field_name_1": "abc",
"field_name_2": "cba"
}
}
]
}
],
"addresses": [
{
"line_1": "31 St, 34 West",
"line_2": "8th Avenue",
"city": "New York",
"state": "New York",
"postal_code": "100018",
"country": "USA",
"current": true,
"permanent": true,
"start_date": "2026-01-01",
"end_date": "2026-01-01"
}
],
"phone_numbers": [
{
"number": "+14044580998",
"type": "mobile",
"primary": true
}
]
}
}
}Response
The request has succeeded.
Example response
{
"data": {
"id": "69ae0e64b02bfe73a44ca479"
}
}