PApaychex
Worker

Worker Communication

Update a "Active" or "In-progress" workers specific communication item.

patch/workers/{workerId}/communications/{communicationId}

Request

Path parameters

workerIdstring required

The id assigned to the worker that workers are being requested for.

communicationIdstring required

The id of a single workers communication.

Request body

communicationIdstring

The ID for the workers specific communication item.

type'STREET_ADDRESS' | 'PO_BOX_ADDRESS' | 'PHONE' | 'MOBILE_PHONE' | 'FAX' | 'EMAIL' | 'PAGER'

A set of communication types classifying an instruction that the customer, requester, or subject must comply with in order for the screening to go forward. NOTE: PHONE and EMAIL type supports BUSINESS and PERSONAL usage type only.MOBILE_PHONE, FAX and PAGER supports BUSINESS usage type only.This data field cannot be PATCHED.

usageType'PERSONAL' | 'BUSINESS' | 'HOME' | 'WORK' | 'LOCATION_STREET_ADDRESS' | 'MAILING_ADDRESS'

A code classifying a designated use associated with a contact method. For example, whether a telephone or email address is one for business communications or one primarily for personal use.This data field cannot be PATCHED.

dialCountrystring

The country dialing code for a communication number

dialAreastring

The area dialing code for a communication number

dialNumberstring

The communication number, not including country dialing or area dialing codes

dialExtensionstring

The extension of the associated communication number

uristring

The mailto address as specified in RFC2368

streetLineOnestring

The street address line one

streetLineTwostring

The street address line two

postOfficeBoxstring

The postal office box. This data field cannot be PATCHED

citystring

The city name

postalCodestring

The zip-code

postalCodeExtensionstring

The zip-code extension

countrySubdivisionCodestring

The state code (ISO 3166 subdivision code)

countryCodestring

The country code (ISO 3166 alpha-2)

_linksLinks

Response

successful operation

Changes

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