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 contact
        • DELDelete a contact
        • GETGet a contact by GUID
        • GETList contacts
        • PUTUpdate a contact
    • Clients/Departments
  • Internal API Reference
    • Applicants/Candidates
    • Clients/Departments
    • Contacts/Managers
LogoLogo
Get SupportGet a demo
Public API Reference (Beta)Contacts/ManagersCore

Create a contact

POST
https://app.brightmove.com/ATS/api/v1/client-contacts
POST
/ATS/api/v1/client-contacts
$curl -X POST https://app.brightmove.com/ATS/api/v1/client-contacts \
>     -H "X-Brightmove-Company-ApiKey: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "firstName": "Jordan",
>  "lastName": "Lee",
>  "clientGuid": "AB8354DA-05D8-5273-E040-A8C05B016031",
>  "clientOfficeGuid": "d085cae4-ee67-4149-af1b-e8366c0061bc"
>}'
201Created
1{}
Was this page helpful?
Previous

Delete a contact

Next
Built with

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