post

https://{domain}/api/{agency_slug}/placements

Create a new placement for a hire, hired candidate, successful hire, or filled position.
Requires person_id, job_id, and start_date; supports salary, bill/pay rate, fee, and split/notification attributes.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

agency_slug

string

required

Body Params

person_id

integer

required

ID of the person being placed

job_id

integer

required

ID of the job the person is being placed in

start_date

date

required

Start date of the placement

end_date

date

End date of the placement

salary

float

Salary amount for the placement

salary_currency_id

integer

ID of the currency for the salary

bill_rate

float

Bill rate for the placement

overtime_bill_rate

float

Overtime bill rate for the placement

bill_rate_type_id

integer

ID of the bill rate type

bill_rate_currency_id

integer

ID of the currency for the bill rate

pay_rate

float

Pay rate for the placement

overtime_pay_rate

float

Overtime pay rate for the placement

pay_rate_type_id

integer

ID of the pay rate type

pay_rate_currency_id

integer

ID of the currency for the pay rate

fee

float

Fee amount for the placement

fee_type_id

integer

ID of the fee type

fee_currency_id

integer

ID of the currency for the fee

job_type_id

integer

ID of the job type

notes

string

Notes about the placement

hours

float

Hours for the placement

days

integer

Days worked per week for daily rate placements (1-7)

splits_attributes

array of objects

splits_attributes

notifications_attributes

array of objects

notifications_attributes

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here!

200success