Update Employee Record

Programmatically update employee records, including contact information and shipping addresses.

PUT
/api/v1/employee/update/{employee_id}

Description

Use the PUT Employee Record endpoint to programmatically update employee records with contact information and shipping addresses. Employee records updated through this API are immediately synchronized across Unduit apps (e.g. Shop, Buyback, Device Hub, Repair).

Request

Path Parameters

ParameterTypeRequiredDescription
employee_idStringYesEncrypted employee ID (e.g., VEl0K0tWdnVwWXJ4ai82RXFXTGNWZz98)

Headers

HeaderValueRequired
AuthorizationBearer <access_token>Yes
Content-Typeapplication/jsonYes

Request Body (JSON)

FieldTypeRequiredDescriptionValidation Rules
firstnameStringYesFirst name of the userMust not be empty, letters and spaces only
lastnameStringYesLast name of the userMust not be empty, letters and spaces only
location_nameStringYesName of the associated locationMust not be empty
location_typeStringYesType of locationMust be: Warehouse, Corporate Office, Retail Store, or Remote Employee
contact_infoNumberYesPhone number for contactMust contain only numbers
emailStringYesEmail address of the contactMust be valid email format and not empty
address_1StringYesAddress line 1Must not be empty
address_2StringNoAddress line 2 (suite, apt, etc.)Optional
cityStringYesCity nameMust not be empty
stateStringYesState or provinceMust not be empty
zipStringYesZip or postal codeMust not be empty
countryStringYesCountry code (ISO 3166-1 alpha-2)Valid ISO 3166-1 alpha-2 code (e.g., US, GB)
contact_countryStringYesCountry code of contact's locationMust not be empty

Response

Response Fields

FieldTypeDescription
messagestringStatus message confirming successful update

Error Responses

Common error responses you may encounter when using this endpoint.

Notes

  • This endpoint requires valid authentication. Include your access token in the Authorization header.
  • The employee_id must be the encrypted employee ID obtained from the Employee Directory endpoint.
  • All required fields must be provided in the request body. Missing or invalid fields will result in an error.
  • The location_type field must be one of the following: Warehouse, Corporate Office, Retail Store, or Remote Employee.
  • Country codes must follow the ISO 3166-1 alpha-2 standard (e.g., US for United States, GB for United Kingdom).
  • Employee records updated via this API are immediately synchronized across all Unduit apps.

Related Endpoints

Did this page help you?