FOfountain
Hiring Goals

Update Hiring Goal

Changed on

Update an existing Hiring Goal

put/v2/hiring_goals/{id}

Request

  • Base URL
    https://api.fountain.com
  • URL
    https://api.fountain.com/v2/hiring_goals/{id}
  • Auth
    API key in header X-ACCESS-TOKEN

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_idstring nullable

External UUID of an Opening in the account or its sub-accounts

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

req_idstring nullable

Requisition ID when requisition hiring goals are enabled

fill_positioninteger nullable

Position in the active fill order when requisition hiring goals are enabled

fills_nextboolean

Whether this goal receives the next hire when requisition hiring goals are enabled

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

Changes

  • 3119e105004cRevision changes
    • breaking

      the request property type changed from boolean to string

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status