Manage Employer Contact Records via the API

Introduction

This is an extension of the Create and Manage Employer Records via the API endpoints. In that collection of endpoints, you can create employer contacts when creating new employers and retrieve employer contact information at a specific employer.

Through this collection of endpoints individual employer contacts can be created, linked to existing employers, and their contact information updated. 

Create New Employer Contacts

It is possible to create a new employer contact and then link it to an existing employer, to do this you will need their contact information and the GUID of the employer.

 

 

Collection Field Name Nullable Data Type Validation
n/a Id Yes GUID You can set the GUID of the record. Must be unique
n/a employerId No GUID Must be a valid Employer GUID
n/a firstName No String  
n/a lastName No String Must be a valid Employer GUID
n/a email No String Must match email regex
n/a phone Yes String Must match phone number regex
n/a jobRole No String  

Endpoint POST   /contact/createWithEmployerId

 

Manage Contacts Personal information

Keeping employer contact information up-to-date and accurate is easy with this simple endpoint.

 

Collection Field Name Nullable Data Type Validation
n/a firstName No String  
n/a lastName No String  
n/a email No String Must match email regex
n/a phone Yes String Must match phone number regex
n/a jobRole No String  

Endpoint PATCH   /contact/{contactId}

 

 

Related to

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request