update_employee
Testing Env
https://testhr.vodoglobal.com
Testing Env
https://testhr.vodoglobal.com
PUT
/api/v1/employees/3419
Last modified:2025-03-26 12:40:51
Update Employee Details
Request Body
user_name (string): The username of the employee.name (string): The name of the employee.user_type (string): The type of user (e.g., employee).type (string): The type of employee (e.g., mail).active (integer): The status of the employee.source (string): The source of the employee.social_situation (string): The social situation of the employee.calendar_id (integer): The calendar ID of the employee.primary_email (string): The primary email of the employee.email (array of strings): The email addresses of the employee.phone (array of strings): The phone numbers of the employee.national_id (string): The national ID of the employee.nationality_id (string): The nationality ID of the employee.occupation_id (integer): The occupation ID of the employee.section_id (integer): The section ID of the employee.Response
status (boolean): Indicates the status of the update operation.message (string): A message related to the update operation.response (object): An object containing the updated employee details.Example Response
{
"status": true,
"message": "",
"response": {
"id": 0,
"name": "",
"business_id": "",
"agent_ids": null,
"type": "",
"active": 0,
"social_situation": "",
"user_type": "",
"primary_email": "",
"email_verified_at": null,
"password": null,
"remember_token": null,
"email": "",
"phone": "",
"profile": null,
"source": "",
"national_id": "",
"nationality_id": "",
"occupation_id": 0,
"section_id": 0,
"job_number": "",
"company_id": 0,
"border_number": "",
"deleted_at": null,
"created_at": "",
"updated_at": "",
"administration_id": 0,
"department_id": 0,
"calendar_id": 0,
"administration_admin": 0,
"trainer": 0,
"emergency_name": "",
"emergency_phone": "",
"user_id": 0,
"user_name": "",
"employer": "",
"employer_company_id": 0,
"employer_branch_id": 0,
"employer_department_id": 0,
"employer_section_id": 0,
"client_id": null,
"color": "",
"bio": null,
"profile_url": ""
}
}
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://testhr.vodoglobal.com/api/v1/employees/3419' \
--header 'secure_business_key: 4765066450c0bd66325.48403130' \
--header 'user_token: ' \
--header 'uuid: 630ca2f4885f8' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
"user_name" : "api-doc-update",
"name": "new test log",
"user_type": "employee",
"type": "mail",
"active": 1,
"source": "referred",
"social_situation": "married",
"calendar_id": 123,
"primary_email": "derey798050@marchub.com",
"email": ["jane.smith@example.com", "jane.smith@work.com"],
"phone": ["555-1234", "555-5678"],
"national_id": "9876564321",
"nationality_id": "1",
"occupation_id": 66,
"section_id": 3,
"company_id": 4,
"job_number": "job123",
"border_no": "border987",
"administration_id": 5,
"administration_admin": 6,
"trainer": 7,
"department_id":7,
"emergency_name": "John Smith",
"emergency_phone": "555-8765",
"employer": "company",
"employer_company_id": 8,
"employer_branch_id": 3,
"employer_department_id": 9,
"employer_section_id": 10,
"client_id": null,
"passport_number": "passport123",
"release_date": "2024-01-01",
"expiry_date": "2034-01-01",
"side_version": "version1",
"function": "developer",
"address": "123 Main St",
"country_code": "US",
"date_of_birth": "1990-05-15",
"insurance_start_date": "2024-01-01",
"insurance_end_date": "2025-01-01",
"place_of_birth": "New York",
"country_of_birth": 1,
"city_id": 2,
"country_id": 3,
"id_issuance_date": "2020-01-01",
"id_expiration_date": "2030-01-01",
"bank_name": "Bank of Example",
"account_name": "Jane Smith",
"account_number": "123456789",
"iban_no": "US123456789",
"currency_id": 1,
"bank_address": "456 Bank St",
"bank_country": 1,
"visa_card": "visa123",
"source_company_id": 4,
"source_administration_id": 5,
"source_section_id": 6,
"building_no": "building123",
"residence": 32,
"branch_start_date": "2024-01-01",
"entering": "2024-01-01",
"expire_h": "2025-01-01",
"expire_m": "2026-01-01",
"work_permit_number": "work123",
"visa_number": "visa456",
"date_of_issuance_of_the_visa": "2024-01-01",
"visa_expiry_date": "2034-01-01",
"branch_id" : 2,
"color" : "#259874",
"skills": [
{
"skill_id": 1,
"level": 70
},
{
"skill_id": 2,
"level": 90
}
],
"schools": [
{
"school_name": "Example University",
"start_date": "2008-09-01",
"end_date": "2012-06-01"
}
],
"experiences": [
{
"company_name": "Tech Solutions",
"occupation_id": 1,
"start_date": "2015-01-01",
"end_date": "2020-12-31"
},
{
"company_name": "Innovative Tech",
"occupation_id": 2,
"start_date": "2021-01-01",
"end_date": "2023-01-01"
}
],
"services_skill": [1, 2]
}'Response Response Example
{
"status": true,
"message": "success",
"response": {
"id": 3419,
"name": "new test log",
"business_id": "259",
"agent_ids": null,
"type": "mail",
"active": 1,
"social_situation": "married",
"user_type": "sub-user",
"primary_email": "derey798050@marchub.com",
"email_verified_at": null,
"password": null,
"remember_token": null,
"email": "[\"jane.smith@example.com\",\"jane.smith@work.com\"]",
"phone": "[\"555-1234\",\"555-5678\"]",
"profile": null,
"source": "referred",
"national_id": "9876564321",
"nationality_id": "1",
"occupation_id": 66,
"section_id": 3,
"job_number": "job123",
"company_id": 4,
"border_number": "border987",
"deleted_at": null,
"created_at": "2025-03-20T09:30:58.000000Z",
"updated_at": "2025-03-20T09:59:37.000000Z",
"administration_id": 5,
"department_id": 7,
"calendar_id": 123,
"administration_admin": 6,
"trainer": 7,
"emergency_name": "John Smith",
"emergency_phone": "555-8765",
"user_id": 1006,
"user_name": "api-doc-update",
"employer": "company",
"employer_company_id": 8,
"employer_branch_id": 3,
"employer_department_id": 9,
"employer_section_id": 10,
"client_id": null,
"color": "#259874",
"bio": null,
"profile_url": "https://testhr.vodoglobal.com/data/employee/profile/user.png"
}
}Request
Header Params
secure_business_key
stringÂ
required
Example:
{{secure_business_key}}
user_token
stringÂ
required
Example:
{{user_token}}
uuid
stringÂ
required
Example:
{{uuid}}
Accept
stringÂ
required
Example:
application/json
Body Params application/json