Public API Reference (Beta)Office/LocationCore

Create a client office

Authentication

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

Request

This endpoint expects an object.
namestringRequired
Display name for the office location.
clientGuidstringRequired

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

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.

primarySalesUserGuidstringOptional
GUID of the BrightMove user to assign as the primary salesperson for this office. Pass an empty string to remove the current assignment.
additionalSalesUserGuidslist of stringsOptional
GUIDs of additional BrightMove users to assign as salespeople for this office.
backOfficeTermIdlongOptional

ID of the back-office payment term to associate with this office. Pass 0 to remove the current association.

accountNamestringOptional

Back-office account name or identifier used for billing integration.

primarybooleanOptional
When true, designates this as the primary office location for the client.

Response

Created