v1

latestOpenAPI 3.0.32026-08-06224144516.1 KB

Pipelines

Create a pipeline

As with all POST endpoints, a location header will be returned with a url to the newly created resource.

post/pipelines

Query parameters

create_activityboolean required

Whether a corresponding activity should be created automatically. This mimics what happens when a pipeline is created from the CATS UI. Defaults to false.

Request body

candidate_idnumber required

The ID of the candidate that this pipeline is regarding.

job_idnumber required

The ID of the job order that this pipeline is for.

ratingnumber

The candidate's rating (0-5) for this job order pipeline.

Response

Created