PApaychex
Worker

Worker Contacts

Update a worker contact. A contact may represent a person or entity (organization) but not both. A contact must have at least one communication (telecom, postal, or email). Person contacts can have multiple communications for each communication type (telecom, postal, or email) to support BUSINESS and PERSONAL. Exactly one contact must be marked as primary for each contact type. When a new contact is made primary the previous primary contact will be marked as not primary. A postal contact can be switched from a street address to a PO box and vice versa. This is done by setting either streetLineOne or postOfficeBox (a postal communication may not have both). Use the GET /companies/{companyId}/contacttypes endpoint to get a full list of available contact types and relationship types (used for person contacts).

patch/workers/{workerId}/contacts/{contactId}

Request

Path parameters

workerIdstring required

ID associated with desired worker.

contactIdstring required

ID associated with desired worker contact.

Request body

contactIdstring

The ID for the workers specific contact.

Example request

{
  "relationship": {
    "person": {
      "name": {
        "familyName": "JONES",
        "middleName": "H",
        "givenName": "INDIANA",
        "preferredName": "Indi",
        "preferredLastName": "Jan",
        "pronoun": "He/him/his",
        "qualificationAffixCode": "Jr",
        "titleAffixCode": "Dr"
      }
    }
  }
}

Response

Successful operation.

Example response

{
  "content": {
    "relationship": {
      "person": {
        "name": {
          "familyName": "JONES",
          "middleName": "H",
          "givenName": "INDIANA",
          "preferredName": "Indi",
          "preferredLastName": "Jan",
          "pronoun": "He/him/his",
          "qualificationAffixCode": "Jr",
          "titleAffixCode": "Dr"
        }
      }
    }
  }
}

Changes

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