Public API Reference (Beta)Placement

Update a placement

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.
startDatestringOptional

ISO-8601 start date of the placement.

endDatestringOptional

ISO-8601 end date of the placement.

hireDatestringOptional

ISO-8601 hire date.

billRatedoubleOptional
Bill rate for this placement.
billTypeIdlongOptional

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

payRatedoubleOptional
Pay rate for this placement.
payTypeIdlongOptional

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

employmentTypeIdlongOptional
ID of the employment type for this placement.
placementTypeIdlongOptional

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

commissionFeedoubleOptional
Flat commission fee.
commissionPctdoubleOptional
Commission percentage.

Response

Placement updated