V1 Update a Business Contact

patch

https://api.elliemae.com/encompass/v1/businessContacts/{contactId}

Updates contact information for the specified contact ID.

IMPORTANT

To update a contact, the firstName OR lastName is required AND one of the following parameters: personalEmail, currentMailingAddress.street1, homePhone, mobilePhone, workPhone.

Path Params

contactId

string

required

The unique identifier that is returned in the response when the contact is created.

Body Params

categoryId

integer

The business category ID for the business contact. Possible values are:

0 - Appraiser

1 - Attorney

2 - Credit Company

3 - Doc Signing

4 - Escrow Company

5 - Flood Insurance

6 - Hazard Insurance

7 - Lender

8 - Mortgage Insurance

9 - Real Estate Agent

10 - Servicing

11 - Title Insurance

12 - Underwriter

13 - Surveyor

14 - No Category

15 - Organization

16 - Verification

17 - Investor

18 - Warehouse Bank

19 - Builder

20 - Dealer

21 - TradeAssignee

categoryFields

array of objects

The category fields managed with the Custom Category Fields tool in Encompass. For more details, see the following Encompass Help topic: Business Custom Fields.

categoryFields

customFields

array of objects

The custom fields managed with the Business Custom Fields tool in Encompass. For more details, see the following Encompass Help topic: Business Custom Fields.

customFields

companyName

string

The contact's company name.

fees

integer

Rate or fee charged by the contact’s services.

personalContactLicense

object

Licensing information.

businessContactLicense

object

Business licensing information.

noSpam

boolean

Indicates whether this contact should be excluded from automated email‑merge operations.

isReadOnly

boolean

Specifies whether this contact is accessible to all loan team members who have the necessary permissions.

firstName

string

Required. The contact's first name.

Note: Either firstName or lastName is required.

lastName

string

Required. The contact's last name.

Note: Either firstName or lastName is required.

ownerId

string

User ID of the user who submitted the API request.

accessLevel

object

Possible values are: 0 – Private, 1- Public.

currentMailingAddress

object

The contact's home address.

bizAddress

object

The contact's business address.

businessWebUrl

string

Website address for the business.

jobTitle

string

The contact's job title.

workPhone

string

The contact's work phone number.

homePhone

string

The contact's home phone number.

mobilePhone

string

The contact's cell phone number.

faxNumber

string

The contact's fax number.

personalEmail

string

The contact's personal email address.

businessEmail

string

Required. The contact's work email address.

primaryEmail

string

The contact's primary email address.

primaryPhone

string

The contact's primary phone number.

salutation

string

Ms., Miss, Mrs., Mr., Dr., etc.

string

The contactId (or id) is the unique identifier of the contact. It is returned in the response header when the contact is created.

groupIDs

array of integers

The unique identifier of each contact group to which the contact belongs.

groupIDs

Headers

Authorization

string

required

Bearer token

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Language

URL