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
  • Internal API Reference
    • Applicants/Candidates
    • Clients/Departments
    • Contacts/Managers
        • GETFind Placement
        • GETGet a Placement
        • POSTPersist Placement
LogoLogo
Get SupportGet a demo
Internal API ReferenceSubmittalsPlacement

Persist Placement

POST
https://app.brightmove.com/ATS/app/submittal/placement
POST
/ATS/app/submittal/placement
$curl -X POST https://app.brightmove.com/ATS/app/submittal/placement \
>     -H "Content-Type: application/json" \
>     -d '{}'
200Successful
1{}
Create or Update a Placement
Was this page helpful?
Previous

Get Submittal Status

Next
Built with

Headers

X-Brightmove-Company-ApiKeystringOptional
X-Brightmove-User-ApiKeystringOptional

Request

This endpoint expects an object.
applicantslist of objectsOptional
reqGklongOptional
guidstringOptional
reqGuidstringOptional
jobTitlestringOptional
applicantGklongOptional
applicantGuidstringOptional
applicantstringOptional
placementTypeobjectOptional
recruiterGklongOptional
recruiterGuidstringOptional
recruiterstringOptional
clientContactGklongOptional
clientContactGuidstringOptional
clientContactstringOptional
clientGklongOptional
clientGuidstringOptional
clientNamestringOptional
officeGklongOptional
officeGuidstringOptional
officeNamestringOptional
startDatedatetimeOptional
endDatedatetimeOptional
hireDatedatetimeOptional
commissionEndDatedatetimeOptional
commissionFeedoubleOptional
commissionPctdoubleOptional
guaranteestringOptional
billRatedoubleOptional
billTypeobjectOptional
payRatedoubleOptional
payTypeobjectOptional
conversionFeedoubleOptional
directFeePctdoubleOptional
directFeeFlatdoubleOptional
bonusPctdoubleOptional
bonusFlatdoubleOptional
bonusNotesstringOptional
mboPctdoubleOptional
mboFlatdoubleOptional
mboNotesstringOptional
employmentTypeobjectOptional
emplCostValuedoubleOptional
emplCostPercentagedoubleOptional
clientFeedoubleOptional
clientDiscountdoubleOptional
currentPlacementbooleanOptional
createUserstringOptional
createUserGklongOptional
createDatedatetimeOptional
modifyUserstringOptional
modifyUserGklongOptional
modifyDatedatetimeOptional
newPlacementbooleanOptional
updateProductPayPlanbooleanOptional
placementProductobjectOptional
udfSectionslist of objectsOptional
displayStartDatestringOptional
displayEndDatestringOptional
displayEmplCostPctAmountstringOptional
hourlyPayRatedoubleOptional
emplCostPctAmountdoubleOptional
emplTotalCostdoubleOptional
hourlyBillRatedoubleOptional
clientDiscountAmountdoubleOptional
realizedBillRatedoubleOptional
netSpreaddoubleOptional
netProfitMargindoubleOptional
commissionAmountdoubleOptional
commissionPctAmountdoubleOptional
directFeeAmountdoubleOptional
directNetProfitdoubleOptional
directNetProfitMargindoubleOptional
totalDirectFeesdoubleOptional
displayHourlyPayRatestringOptional
displayEmplCostValuestringOptional
displayEmplCostPctstringOptional
displayEmplTotalCoststringOptional
displayClientFeestringOptional
displayClientDiscountstringOptional
displayClientDiscountAmountstringOptional
displayHourlyBillRatestringOptional
displayRealizedBillRatestringOptional
displayNetSpreadstringOptional
displayNetProfitMarginstringOptional
displayBillRatestringOptional
displayBonusFlatstringOptional
displayBonusPctstringOptional
displayCommissionAmountstringOptional
displayCommissionFeestringOptional
displayCommissionPctstringOptional
displayCommissionPctAmountstringOptional
displayDirectFeeAmountstringOptional
displayDirectFeeFlatstringOptional
displayDirectFeePctstringOptional
displayDirectNetProfitstringOptional
displayDirectNetProfitMarginstringOptional
displayMboFlatstringOptional
displayMboPctstringOptional
displayPayRatestringOptional
displayTotalDirectFeesstringOptional
displayCommissionEndDatestringOptional
displayHireDatestringOptional

Response

OK