Documentation
Organization Structure API
- Axis-sections
- Departments
- Legal-Units
- Establishments
Core HR API
Expenses API
- Expense-temp-items
- Expense-claims
- Expense-claim-items
- Exports
- Guides
Invoices API
- Guides
Absences API
- Leaves
- Leave-requests
- Sick-leaves
- Imports
- Guides
Office API
- User-locations
- Work-locations
Project API
- Clients
- Projects
- Project services
- Organizations
- Financials
Time Settings API
- UserDates
- Workcycle-exceptions
- Working-time-arrangement
Timesheet API
- Time-entries
- Timesheets
- Reports
- Guides
Mealvouchers API
- Statutory
- Computation
Compensation API
- Fixed-natures
- Fixed-items
- Variable-natures
- Variable-items
Training API
- Training-demands
- Realized-trainings
Employees Directory
Update a User by id
Update fields of a single User identified by its unique id.
PUT
/
api
/
v3
/
users
/
{id}
Copy
curl --request PUT \
--url https://{host}/api/v3/users/{id} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"data": {
"firstName": "John",
"lastName": "Doe",
"mail": "jdoe@corp.com",
"login": "jdoe",
"legalEntityId": 1,
"dtContractStart": "2025-01-01T00:00:00",
"cspId": 2,
"calendarId": null,
"employeeNumber": "000000452",
"birthDate": "1989-12-22T00:00:00",
"userWorkCycles": [
{
"id": 67,
"startsOn": "1920-01-01T00:00:00",
"endsOn": "2220-01-01T00:00:00",
"workCycleID": 9
}
],
"departmentId": 14,
"managerId": 455,
"rolePrincipalId": 55,
"habilitedRoles": [
{
"id": 59
},
{
"id": 81
},
{
"id": 64
},
{
"id": 65
}
],
"cultureID": 1040,
"address": "13, rue Martin Bernard, 75 Paris",
"directLine": "0123456789",
"jobTitle": "Developer",
"gender": "Male",
"nationalityId": "FR",
"personalEmail": "email@test.fr",
"personalMobile": "0612345678",
"professionalMobile": "0612345678",
"quote": "string",
"e_bloodType": "AB",
"profile_figgo": {
"id": 156
},
"userAxisValues_2": {
"id": 35
},
"allowsElectronicPayslip": true,
"bankName": "Banque Postale",
"rib": null,
"iban": "FR0312739000302346383836C42",
"bic": "PSSTFRPPXXX",
"frenchCarTaxHorsePower": 5,
"frenchMotocyclesTaxHorsePower": null
}
}'
Copy
{
"data": {
"id": 416,
"name": "John Doe",
"url": "http://example.ilucca.net/api/users/1",
"displayName": "Doe John",
"modifiedAt": "2015-09-07T10:20:06.583",
"lastName": "DOE",
"firstName": "John",
"login": "jdoe",
"mail": "no-reply@lucca.fr",
"dtContractStart": "2014-09-01T00:00:00",
"dtContractEnd": null,
"birthDate": "1989-12-22T00:00:00",
"employeeNumber": "00057",
"calendarId": 1,
"calendar": {
"id": 1,
"url": "http://example.ilucca.net/api/v3/publicHolidayCalendars/1",
"name": "Jours fériés en France"
},
"cultureID": 1036,
"culture": {
"id": 1036,
"name": "français (France)",
"url": "http://example.ilucca.net/api/v3/cultures/1036"
},
"picture": {
"id": "74d381db-dd4d-4f64-bc1e-582d806e58a8",
"url": "http://example.ilucca.net/api/v3/files/74d381db-dd4d-4f64-bc1e-582d806e58a8",
"name": "jdoe.png"
},
"legalEntityId": 1,
"legalEntity": {
"id": 1,
"name": "Lucca",
"url": "http://example.ilucca.net/api/v3/legalEntities/1"
},
"departmentId": 13,
"department": {
"id": 13,
"name": "BU Timmi/Lucca",
"url": "http://example.ilucca.net/api/v3/departments/13"
},
"managerId": 383,
"manager": {
"id": 383,
"name": "Roger Smith",
"url": "http://example.ilucca.net/api/v3/users/383"
},
"rolePrincipalId": 55,
"rolePrincipal": {
"id": 55,
"name": "User",
"url": "http://example.ilucca.net/api/v3/roles/55"
},
"habilitedRoles": [
{
"id": 59,
"name": "Employee +",
"url": "http://example.ilucca.net/api/v3/roles/59"
},
{
"id": 63,
"name": "Analytics access",
"url": "http://example.ilucca.net/api/roles/63"
}
],
"userWorkCycles": [
{
"id": 288,
"ownerID": 416,
"workCycleID": 6,
"startsOn": "1900-01-01T00:00:00",
"endsOn": "2015-03-09T00:00:00"
},
{
"id": 289,
"ownerID": 416,
"workCycleID": 9,
"startsOn": "2015-03-10T00:00:00",
"endsOn": "2015-10-13T00:00:00"
},
{
"id": 317,
"ownerID": 416,
"workCycleID": 14,
"startsOn": "2015-10-13T00:00:00",
"endsOn": "9999-12-31T00:00:00"
}
],
"allowsElectronicPayslip": true,
"userAxisValues_2": {
"id": 35
}
}
}
Headers
API key. Value must be formatted like so: lucca application={api_key}
.
Path Parameters
ID of the user.
Query Parameters
Comma-separated list of fields of the user to include in responses. Extended data can be retrieved with ?fields=extendedData
.
Body
application/json
Response
200
application/json
OK
The response is of type object
.
Was this page helpful?
Copy
curl --request PUT \
--url https://{host}/api/v3/users/{id} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"data": {
"firstName": "John",
"lastName": "Doe",
"mail": "jdoe@corp.com",
"login": "jdoe",
"legalEntityId": 1,
"dtContractStart": "2025-01-01T00:00:00",
"cspId": 2,
"calendarId": null,
"employeeNumber": "000000452",
"birthDate": "1989-12-22T00:00:00",
"userWorkCycles": [
{
"id": 67,
"startsOn": "1920-01-01T00:00:00",
"endsOn": "2220-01-01T00:00:00",
"workCycleID": 9
}
],
"departmentId": 14,
"managerId": 455,
"rolePrincipalId": 55,
"habilitedRoles": [
{
"id": 59
},
{
"id": 81
},
{
"id": 64
},
{
"id": 65
}
],
"cultureID": 1040,
"address": "13, rue Martin Bernard, 75 Paris",
"directLine": "0123456789",
"jobTitle": "Developer",
"gender": "Male",
"nationalityId": "FR",
"personalEmail": "email@test.fr",
"personalMobile": "0612345678",
"professionalMobile": "0612345678",
"quote": "string",
"e_bloodType": "AB",
"profile_figgo": {
"id": 156
},
"userAxisValues_2": {
"id": 35
},
"allowsElectronicPayslip": true,
"bankName": "Banque Postale",
"rib": null,
"iban": "FR0312739000302346383836C42",
"bic": "PSSTFRPPXXX",
"frenchCarTaxHorsePower": 5,
"frenchMotocyclesTaxHorsePower": null
}
}'
Copy
{
"data": {
"id": 416,
"name": "John Doe",
"url": "http://example.ilucca.net/api/users/1",
"displayName": "Doe John",
"modifiedAt": "2015-09-07T10:20:06.583",
"lastName": "DOE",
"firstName": "John",
"login": "jdoe",
"mail": "no-reply@lucca.fr",
"dtContractStart": "2014-09-01T00:00:00",
"dtContractEnd": null,
"birthDate": "1989-12-22T00:00:00",
"employeeNumber": "00057",
"calendarId": 1,
"calendar": {
"id": 1,
"url": "http://example.ilucca.net/api/v3/publicHolidayCalendars/1",
"name": "Jours fériés en France"
},
"cultureID": 1036,
"culture": {
"id": 1036,
"name": "français (France)",
"url": "http://example.ilucca.net/api/v3/cultures/1036"
},
"picture": {
"id": "74d381db-dd4d-4f64-bc1e-582d806e58a8",
"url": "http://example.ilucca.net/api/v3/files/74d381db-dd4d-4f64-bc1e-582d806e58a8",
"name": "jdoe.png"
},
"legalEntityId": 1,
"legalEntity": {
"id": 1,
"name": "Lucca",
"url": "http://example.ilucca.net/api/v3/legalEntities/1"
},
"departmentId": 13,
"department": {
"id": 13,
"name": "BU Timmi/Lucca",
"url": "http://example.ilucca.net/api/v3/departments/13"
},
"managerId": 383,
"manager": {
"id": 383,
"name": "Roger Smith",
"url": "http://example.ilucca.net/api/v3/users/383"
},
"rolePrincipalId": 55,
"rolePrincipal": {
"id": 55,
"name": "User",
"url": "http://example.ilucca.net/api/v3/roles/55"
},
"habilitedRoles": [
{
"id": 59,
"name": "Employee +",
"url": "http://example.ilucca.net/api/v3/roles/59"
},
{
"id": 63,
"name": "Analytics access",
"url": "http://example.ilucca.net/api/roles/63"
}
],
"userWorkCycles": [
{
"id": 288,
"ownerID": 416,
"workCycleID": 6,
"startsOn": "1900-01-01T00:00:00",
"endsOn": "2015-03-09T00:00:00"
},
{
"id": 289,
"ownerID": 416,
"workCycleID": 9,
"startsOn": "2015-03-10T00:00:00",
"endsOn": "2015-10-13T00:00:00"
},
{
"id": 317,
"ownerID": 416,
"workCycleID": 14,
"startsOn": "2015-10-13T00:00:00",
"endsOn": "9999-12-31T00:00:00"
}
],
"allowsElectronicPayslip": true,
"userAxisValues_2": {
"id": 35
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.