PApaylocity
Emergency Contacts

Add/update emergency contacts

Sends new or updated employee emergency contacts directly to Web Pay.

put/v2/companies/{companyId}/employees/{employeeId}/emergencyContacts

Request

  • Base URL
    https://api.paylocity.com/api
  • URL
    https://api.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/emergencyContacts
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.paylocity.com/IdentityServer/connect/token scopes: WebLinkAPI

Path parameters

companyIdstring required

Company Id

employeeIdstring required

Employee Id

Request body

address1string nullable

1st address line.

address2string nullable

2nd address line.

citystring nullable

City.

countrystring nullable

County.

countystring nullable

Country.  Must be a valid 3 character country code.  Common values are USA (United States), CAN (Canada).

emailstring nullable

Contact email.  Must be valid email address format.

firstNamestring nullable required

Required. Contact first name. <br />Max length: 40

homePhonestring nullable

Contact Home Phone.  Valid phone format  (###) ####### or ######-#### or ### ### #### or ########## or, if international, starts with +#, only spaces and digits allowed.

lastNamestring nullable required

Required. Contact last name. <br />Max length: 40

mobilePhonestring nullable

Contact Mobile Phone.  Valid phone format  (###) ####### or ######-#### or ### ### #### or ########## or, if international, starts with +#, only spaces and digits allowed.

notesstring nullable

Notes. <br />Max length: 1000

pagerstring nullable

Contact Pager.  Valid phone format  (###) ####### or ######-#### or ### ### #### or ########## or, if international, starts with +#, only spaces and digits allowed.

primaryPhonestring nullable

Required. Contact primary phone type.  Must match Company setup.  Valid  values are H (Home), M (Mobile), P (Pager), W (Work)

prioritystring nullable

Required. Contact priority. Valid values are P (Primary) or S (Secondary).

relationshipstring nullable

Required. Contact relationship.  Must match Company setup.  Common values are Spouse, Mother, Father.

statestring nullable

State or Province.  If U.S. address, must be valid 2 character state code.  Common values are IL (Illinois), CA (California).

syncEmployeeInfoboolean

Valid values are true or false.

workExtensionstring nullable

Work Extension.

workPhonestring nullable

Contact Work Phone.  Valid phone format  (###) ####### or ######-#### or ### ### #### or ########## or, if international, starts with +#, only spaces and digits allowed.

zipstring nullable

Postal code.  If U.S. address, must be a valid zip code.

Response

Successfully added or updated

Changes

No recorded changes to this operation across all 4 revisions of this API.