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

Create a placement

POST
https://app.brightmove.com/ATS/api/v1/placements
POST
/ATS/api/v1/placements
$curl -X POST https://app.brightmove.com/ATS/api/v1/placements \
>     -H "X-Brightmove-Company-ApiKey: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "requirementGuid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
>  "applicantGuid": "d4e5f6a7-b8c9-0123-defa-234567890123",
>  "startDate": "2025-04-01T00:00:00Z",
>  "hireDate": "2025-04-01T00:00:00Z",
>  "billTypeId": 1,
>  "payTypeId": 1,
>  "employmentTypeId": 6748,
>  "placementTypeId": 2
>}'
201Created
1{}
Was this page helpful?
Previous

Delete a placement

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.
requirementGuidstringRequired
GUID of the requirement this placement is for.
applicantGuidstringRequired
GUID of the applicant being placed.
startDatestringRequired

ISO-8601 start date of the placement.

hireDatestringRequired

ISO-8601 hire date of the placement.

billTypeIdlongRequired

ID of the bill type (pay period). 1=Hourly, 2=Daily, 3=Monthly, 4=Annually, 5=Weekly, 6=Biweekly.

payTypeIdlongRequired

ID of the pay type (pay period). 1=Hourly, 2=Daily, 3=Monthly, 4=Annually, 5=Weekly, 6=Biweekly.

employmentTypeIdlongRequired
ID of the employment type for this placement.
placementTypeIdlongRequired

ID of the placement type. 1=Contract, 2=Permanent, 3=Internal, 4=Contract to Hire.

endDatestringOptional

ISO-8601 end date of the placement. Defaults to startDate if omitted.

billRatedoubleOptional
Bill rate for this placement.
payRatedoubleOptional
Pay rate for this placement.
commissionFeedoubleOptional
Flat commission fee.
commissionPctdoubleOptional
Commission percentage.

Response

Placement created