PApaychex
Worker

Worker Contacts

Add one or more contacts to a worker. 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. If one or more contacts are posted for the same contact type, and there are currently no contacts of that type for the worker, the first contact in the list will be made primary unless another in the list is expressly marked as primary. When a new contact is made primary the previous primary contact will be marked as not primary. Use the GET /companies/{companyId}/contacttypes endpoint to get a full list of available contact types and relationship types (used for person contacts).

post/workers/{workerId}/contacts

Request

Path parameters

workerIdstring required

ID associated with desired worker.

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.