PApaychex
Worker

Worker CustomField

Update CustomField at the worker level

patch/workers/{workerId}/customfields/{workerCustomFieldId}

Request

Path parameters

workerIdstring required

ID associated with desired worker.

workerCustomFieldIdstring required

ID associated with desired worker custom field.

Request body

workerCustomFieldIdstring

The unique identifier that is autogenerated when a custom field is created

customFieldIdstring

client Custom Field Id

type'DROPDOWN' | 'TEXT' | 'BOOLEAN' | 'DATE' | 'NUMERIC, NUMERIC__0_00_ OR NUMERIC__0_0000_'

The type of field the custom field is

booleanValueboolean

The value for BOOLEAN type (true/false)

textValuestring

The value for TEXT type (any text, alphanumeric, special characters allowed)

numericValuenumber

Numeric data type can have three formats namely - whole number, second decimal place and fourth decimal place, example: 12 , 12.34 or 12.3456

dateValuestring date-time

The value for DATE type , example : 2012-02-01T05:00:00Z

dropdownIdstring

The unique identifier that is autogenerated when dropdown list is created

dropdownValuestring

The value for dropdown list

customFieldNamestring

The name of the custom field. Such as: "Hobbies"

requiredboolean

Where to indicate if the custom field is required on the worker where true = required and false = not required

checkStubboolean

Where to indicate if the custom field is required on the workers pay stub, where true = required and false = not required.

employeeEditableboolean

Where to indicate if the custom field is able to be edited by the employee, where true = required and false = not required.

Response

Worker Custom field successfully updated

Changes

No recorded changes to this operation across all 1 revision of this API.