Public API Reference (Beta)Clients/DepartmentsCore

Create a client

Creates a new client company. Required field for creation: companyName. Related references (sales users, workgroup, term, state) are validated when provided.

Authentication

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

Request

This endpoint expects an object.
companyNamestringRequired
Client company name.
websitestringOptional
Company website URL.
billAddress1stringOptional
Billing address line 1.
billAddress2stringOptional
Billing address line 2.
billCitystringOptional
Billing city.
billCountrystringOptional
Billing country.
billPostalCodestringOptional
Billing postal code.
billStateIdlongOptional

State ID for billing state. Use GET /api/v1/lookup/states to retrieve valid IDs.

discountPercentagedoubleOptional
Discount percentage applied to invoices.
discountFeedoubleOptional
Fixed discount fee applied to invoices.
stockSymbolstringOptional
Stock ticker symbol.
companyInfostringOptional
Company profile or internal notes.
accountNamestringOptional
Internal account name used for billing integration.
legacyIdstringOptional
Legacy identifier from an external system.
overrideEeocbooleanOptional

When true, overrides company-level EEOC question defaults for this client.

overrideVeteranStatusbooleanOptional

When true, overrides company-level veteran status question defaults for this client.

overrideDisabledStatusbooleanOptional

When true, overrides company-level disability status question defaults for this client.

overrideJobBoardCompanybooleanOptional

When true, overrides company-level job board company behavior for this client.

createMainbooleanOptional
When true, automatically creates a primary office location for this client on creation.
primarySalesUserGuidstringOptional
GUID of the BrightMove user to assign as the primary salesperson.
additionalSalesUserGuidslist of stringsOptional
GUIDs of additional BrightMove users to assign as salespeople.
workgroupIdlongOptional
Workgroup ID to assign to this client.
backOfficeTermIdlongOptional

Back-office billing term ID to assign to this client.

Response

Client created successfully