Create a contact

Authentication

X-Brightmove-Company-ApiKeystring
BrightMove Company Api Key
X-Brightmove-User-ApiKeystring
BrightMove User Api Key

Request

This endpoint expects an object.
firstNamestringRequired
Contact's first name.
lastNamestringRequired
Contact's last name.
clientGuidstringRequired

GUID of the client (company) this contact belongs to.

clientOfficeGuidstringRequired
GUID of the client office location this contact is associated with.
middleNamestringOptional
Contact's middle name or initial.
titlestringOptional
Contact's job title at their company.
departmentstringOptional
Department the contact belongs to.
emailstringOptional
Contact's primary email address.
workEmailstringOptional
Contact's work email address.
emailAllowedbooleanOptional
When true, the contact has opted in to email communications.
smsAllowedbooleanOptional

When true, the contact has opted in to SMS/text message communications.

addressstringOptional
Street address line 1.
address2stringOptional

Street address line 2 (suite, floor, etc.).

citystringOptional
City.
stateIdlongOptional

State ID from the BrightMove state lookup. Use GET /api/v1/lookup/states to retrieve valid IDs.

postalCodestringOptional

Postal (ZIP) code.

countrystringOptional
Country.
salesPersonGuidstringOptional
GUID of the BrightMove user to assign as the primary salesperson for this contact. Pass an empty string to remove the current assignment.
additionalSalesPersonGuidslist of stringsOptional
GUIDs of additional BrightMove users to assign as salespeople for this contact.

Response

Created