Worker Communications

Endpoint: https://api.paychex.com/workers/{workerId}/communications

Verbs supported: GET & POST

GET: Information about a workers communications.

POST: Add a single communication to the worker.

Request:

Element NameTypeDescription
workerId stringThe id assigned to the worker that workers are being requested for.

Response:

VerbProfileDescription
GEThttp://api.paychex.com/profiles/people/worker/communications/v1Workers communication profile.
POSThttp://api.paychex.com/profiles/people/worker/communications/v1The single newly added workers communication profile.

Endpoint:https://api.paychex.com/workers/{workerId}/communications/{communicationId}

Verbs supported: GET & PATCH & DELETE

GET: A workers single communication item.

PATCH: Update a workers specific communication item.

DELETE: Remove a communication item from a worker.

Request:

Element NameTypeDescription
workerId stringThe id assigned to the worker that workers are being requested for.
communicationIdstringThe id of a single workers communication.

Response:

VerbProfileDescription
GEThttp://api.paychex.com/profiles/people/worker/communication/v1Workers single communication profile.
PATCHhttp://api.paychex.com/profiles/people/worker/communication/v1Workers single communication profile.
DELETEhttp://api.paychex.com/profiles/people/worker/communication/v1Status of the request.

Response

Profile: Worker Communications

The representational state of the workers communications.
Element NameTypeDescription
communicationIdstringThe ID for the workers specific communication item.
typestringA set of communication types classifying an instruction that the customer, requester, or subject must comply with in order for the screening to go forward.
  • STREET_ADDRESS
  • PO_BOX_ADDRESS
  • PHONE
  • MOBILE_PHONE
  • FAX
  • EMAIL
  • PAGER
usageTypestringA 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.
  • PERSONAL
  • BUSINESS
dialCountrystringThe country dialing code for a communication number.
dialAreastringThe area dialing code for a communication number.
dialNumberstringThe communication number, not including country dialing or area dialing codes.
dialExtentionstringThe extension of the associated communication number.
uristringThe mailto address as specified in RFC2368 .
streetLineOnestringThe street address line one
streetLineTwostringThe street address line two
postOfficeBoxstringThe postal office box
citystringThe city name
countrySubdivisionCodestringThe state code (ISO 3166 subdivision code)
postalCodestringThe zip-code
countryCodestringThe country code (ISO 3166 alpha-2)
{
  "content": [
    {
      "communicationId": "00Z5V9BTINBT97UMERCA",
      "type": "EMAIL",
      "usageType": "BUSINESS",
      "uri": "jd_work@noreplay.com",
      "links": [
        {
          "rel": "self",
          "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/communications/00Z5V9BTINBT97UMERCA"
        }
      ]
    },
    {
     "communicationId": "00Z5V9BTINBT97UMERCB",
      "type": "PHONE",
      "usageType": "BUSINESS",
      "dialCountry": "1",
      "dialArea": "999",
      "dialNumber": "8887777",
      "dialExtension": "6",
      "links": [
        {
          "rel": "self",
          "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/communications/00Z5V9BTINBT97UMERCB"
        }
      ]
    },
    {
      "communicationId": "00Z5V9BTINBT97UMERCC",
      "type": "MOBILE_PHONE",
      "usageType": "BUSINESS",
      "dialCountry": "1",
      "dialArea": "777",
      "dialNumber": "6665555",
      "links": [
        {
          "rel": "self",
          "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/communications/00Z5V9BTINBT97UMERCC"
        }
      ]
    },
    {
      "communicationId": "00Z5V9BTINBT97UMERCD",
      "type": "FAX",
      "usageType": "BUSINESS",
      "dialCountry": "1",
      "dialArea": "555",
      "dialNumber": "4443333",
      "links": [
        {
          "rel": "self",
          "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/communications/00Z5V9BTINBT97UMERCD"
        }
      ]
    },
    {
      "communicationId": "00Z5V9BTINBT97UMERCE",
      "type": "PAGER",
      "usageType": "BUSINESS",
      "dialCountry": "1",
      "dialArea": "666",
      "dialNumber": "5554444",
      "links": [
        {
          "rel": "self",
          "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/communications/00Z5V9BTINBT97UMERCE"
        }
      ]
    },
    {
      "communicationId": "00Z5V9BTINBT97UMERCF",
      "type": "STREET_ADDRESS",
      "streetLineOne": "1 Main Street",
      "streetLineTwo": "Office 3",
      "city": "Webster",
      "countrySubdivisionCode": "NY",
      "postalCode": "14580",
      "countryCode": "US",
      "links": [
        {
          "rel": "self",
          "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/communications/00Z5V9BTINBT97UMERCF"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "self",
      "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/communications"
    },
    {
      "rel": "create",
      "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/communications"
    }
  ]
}