For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get SupportGet a demo
  • Get Started
    • Welcome
    • Quickstart
  • Webhooks
    • Introduction
    • Creating a Webhook
    • Available Webhooks
  • Public API Reference (Beta)
    • Applicants/Candidates
    • Contacts/Managers
        • POSTCreate a client office
        • DELDelete a client office
        • GETGet a client office by GUID
        • GETList client offices
        • PUTUpdate a client office
    • Clients/Departments
  • Internal API Reference
    • Applicants/Candidates
    • Clients/Departments
    • Contacts/Managers
LogoLogo
Get SupportGet a demo
Public API Reference (Beta)Office/LocationCore

Update a client office

PUT
https://app.brightmove.com/ATS/api/v1/client-offices/:guid
PUT
/ATS/api/v1/client-offices/:guid
$curl -X PUT https://app.brightmove.com/ATS/api/v1/client-offices/guid \
>     -H "X-Brightmove-Company-ApiKey: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
200Updated
1{}
Was this page helpful?
Previous

Client API

Client API operations.
Next
Built with

Authentication

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

Path parameters

guidstringRequired

Request

This endpoint expects an object.
namestringOptional
Display name for the office location.
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.

clientGuidstringOptional

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

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

OK