Users

Replaces every updatable field of a contractor (BF-7493).

Full replace. Required, and a 400 naming each one when missing or null: firstName, lastName, emailAddress, isElectronicDelivery, is1099, isSickTimeEnabled, isVacationTimeEnabled, isHealthInsuranceEnabled. Every other updatable field that is absent or null is cleared - including socialSecurityNumber, dateOfBirth, routingNumber and accountNumber; to change only some fields use PATCH. Field names are those of GET: merge data.contractorData and data.contractorUserProfile into one object and send it back. Keys that are not updatable (isActive, userId, atsSyncId, userName, ...) are ignored; isActive is never written. customFields changes only the fields listed, as [{ customFieldName, customFieldItemName }]; an empty customFieldItemName clears one; absent or null leaves custom fields alone. Rules such as zip code, phone or SSN format apply only to values that change. A contractorId in the body must equal the route. When every value equals the stored one nothing is written. dateOfBirth must be a calendar date yyyy-MM-dd; a changed value with a time zone (Z or an offset) is a 400. Error messages never repeat personal values, except that custom-field errors name the custom field and list item.

put/v{version}/Users/contractors/{contractorId}

Path parameters

contractorIdinteger required

Contractor to update.

versionstring required

Headers

company-idstring required

Request body

companyIdstring uuid
contractorIdinteger
firstNamestring nullable
middleNamestring nullable
lastNamestring nullable
titlestring nullable
emailAddressstring nullable
phonestring nullable
phoneExtstring nullable
isElectronicDeliveryboolean nullable
address1string nullable
address2string nullable
citystring nullable
zipCodestring nullable
stateCodestring nullable
stateWorkingstring nullable
stateSubjectToTaxstring nullable
socialSecurityNumberstring nullable
dateOfBirthstring date-time nullable
genderstring nullable
routingNumberstring nullable
accountNumberstring nullable
federalFilingStatusIdinteger nullable
stateFilingStatusIdinteger nullable
stateFilingCodestring nullable
federalAllowancenumber double nullable
stateAllowancenumber double nullable
additionalFederalWithholdingsnumber double nullable
additionalStateWithholdingsnumber double nullable
otherIncomeAmountnumber double nullable
otherDeductionAmountnumber double nullable
totalDependentClaimAmountnumber double nullable
isFederalTaxExemptboolean nullable
isStateTaxExemptboolean nullable
isHasTwoJobsboolean nullable
isI9OnFileboolean nullable
paycheckDeliveryIdinteger nullable
paycheckDeliveryAccountTypeIdinteger nullable
is1099boolean nullable
contractorCompanystring nullable
isSickTimeEnabledboolean nullable
isVacationTimeEnabledboolean nullable
isHealthInsuranceEnabledboolean nullable

Response

Success

isValidboolean
errorsstring[] nullable
warningsstring[] nullable
infostring[] nullable
messagestring nullable

Changes

No recorded changes to this endpoint across all 8 revisions of this API.