Skip to main content
POST
Create a placement

Authorizations

x-api-key
string
header
required

Body

application/json
externalId
string
required

Candidate ID in your system.

jobId
string<uuid>
required

Ready Health job ID (POST /job / GET /job/{id}).

atsPlacementRefId
string

Placement ID in the ATS.

vmsPlacementRefId
string
candidateName
string
candidateEmail
string
candidatePhone
string
startDate
string<date>

Assignment start date (YYYY-MM-DD or ISO).

Response

201 - application/json

Placement. Same shape as GET /placement/{id}.

id
string<uuid>
status
enum<string>
Available options:
ACTIVE,
COMPLETED,
CANCELLED
job
object
candidate
object
atsPlacementRefId
string | null
vmsPlacementRefId
string | null
packets
object[]
requirementCount
integer
fulfilledCount
integer
requirements
object[]