Sign in

v1

latestOpenAPI 3.0.12026-07-245752052.0 MB
Hiring Goals

Update Hiring Goal

Update an existing Hiring Goal

put/v2/hiring_goals/{id}

Path parameters

idstring required

The Hiring Goal ID

Request body

start_datestring

Start date of the Hiring Goal

hire_bystring

The date that the Hiring Goal ends

goalstring

The number of hires needed for this Hiring Goal

opening_idboolean nullable

The Opening (also known as Funnel) this Hiring Goal applies to

automatically_close_on_datestring nullable

The date that the Hiring Goal will automatically close

Response

Ok

automatically_close_on_datestring nullable

Date that the Hiring Goal will automatically close

closed_atstring datetime

The date and time at which the hiring goal was closed

created_atstring datetime

The date and time at which the hiring goal was created

external_idstring

Unique identifier of the Hiring Goal

funnel_idstring

Unique identifier of the associated opening

goalinteger

Number of hires needed for this Hiring Goal

hire_bystring

Date that the Hiring Goal ends

hires_countinteger

Number of hires currently associated with the Hiring Goal

last_updated_atstring datetime

The date and time at which the hiring goal was last updated

past_dueboolean

Indicates if the hire_by date is in the past

remaining_daysinteger

Number of days until this Hiring Goal ends

stage_idstring

Unique identifier of the associated stage

start_datestring

Date that the Hiring Goal begins

status'unfilled' | 'filled'

Current status of the Hiring Goal