Update Employee Record

Update an existing employee record, including contact information and shipping addresses.

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

Description

Use the PUT Employee Record endpoint to update an existing employee record with contact information and shipping addresses. You must send the full set of required fields in the request body (this is not a partial update). The record must belong to your organization and must not be deleted.

Request

Headers

HeaderValueRequired
AuthorizationBearer <access_token>Yes
Content-Typeapplication/jsonYes

Path Parameters

ParameterTypeRequiredDescription
idStringYesEmployee/address identifier. Use the address.id from the Create Employee response. URL-encode the value when it contains special characters.

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
addressobjectThe updated employee record with all fields
address.idnumberUnique identifier for the employee record
address.firstnamestringEmployee's first name
address.lastnamestringEmployee's last name
address.emailstringEmployee's email address
address.location_namestringName of the associated location
address.location_typestringType of location (Warehouse, Corporate Office, etc.)
address.contact_infostringPhone number
address.company_idnumberCompany identifier
address.created_atstringTimestamp when record was created
address.updated_atstringTimestamp of last update

Notes

  • This endpoint requires valid authentication. Include your access token in the Authorization header.
  • Use the address.id from a Create Employee response as the path id. URL-encode the value when required.
  • All required fields must be provided in the request body. Missing or invalid fields return a validation 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).
  • Updated employee records are immediately available across all Unduit apps.

Related Endpoints

Did this page help you?