Update opening

put

https://api.fountain.com/v2/funnels/{id}

Update an existing Opening.
On four-state accounts, an explicit sourcing status takes precedence over legacy posting fields.
Listing defaults and internal window fields are returned only on four-state accounts.
When go_enabled is set to true, the opening is deactivated as part of go-enablement
(the opening is set to inactive so it can be managed through Hire Go; it can be
reactivated after Go is configured). The account must have Hire Go enabled and
the opening's workflow must be go-compatible for go_enabled to take effect.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The Opening ID

Body Params

active

boolean | null

Indicator for whether the opening is active

additional_info

string | null

Additional info about the opening

alternative_locales

array of strings | null

List of alternate locales

alternative_locales

compensation_currency_code

string | null

The currency of the pay rate

compensation_type

string | null

enum

How often the pay occurs

Allowed:

compensation

string | null

The pay rate

custom_id

string | null

Identifier custom to opening for the account

hris_id

string | null

ATS job ID. Set once and unique among live openings in the account. A different or blank value is refused once set; null leaves it unchanged.

customer_attributes

array of objects | null

List of customer attributes for the opening

customer_attributes

do_launch_portal_from_form

boolean | null

Indicator for whether to launch the applicant into the workflow after application

external_title

string | null

Title that will be show on sourcing and career sites

force_applicant_identity

boolean | null

Indicator for whether applicant identity is enforced

is_hiring_funnel

boolean | null

Indicator for whether the opening is for hiring

is_private

boolean | null

Indicator for whether the opening is private

is_sourcing_funnel

boolean | null

Indicator for whether the opening is for sourcing

listing_status

string

enum

Sourcing status on an account running the four-state model. Ignored on legacy accounts. Omit it to move the opening to its configured activation or deactivation default when active changes. Sent beside active, it overrides that default and must be valid for the new active state: Public and Internal require an active opening, and Internal also requires the internal career site; otherwise the request is refused with 422. Go-enablement deactivates the opening, so a Public or Internal status beside go_enabled true is refused. When sent, it takes precedence over is_sourcing_funnel, is_internal_funnel and unlisted_from_sourcing.

Allowed:

job_hours

string | null

enum

Indicator for whether the opening is full or part time

Allowed:

job_industry

string | null

enum

Industry the opening is for

job_type

string | null

enum

The type of job represented by the opening

location_id

string | null

The unique identifier for the location associated to the opening

owner_id

string | null

The unique identifier for the owner to be associated to the opening

position_id

string | null

The unique identifier for the position associated to the opening

shift_attributes

object

The values to update an existing shift or define a new shift for the opening

shift_id

string | null

The unique identifier for the shift to be associated to the opening

title

string | null

The title of the opening

use_obiq_form

boolean | null

Indicator for whether an external application form will be used

workflow_id

string | null

The unique identifier for the workflow to associate to the opening

is_internal_funnel

boolean

Indicates whether the opening is an internal job posting. Cannot be true together with is_sourcing_funnel. On four-state accounts, an explicit listing_status determines both posting fields.

internal_job_duration

integer

Internal posting window in days: 1, 2, 3, 5, 7, or 14. On four-state accounts, the setting persists on any opening and the window starts when it becomes Internal. Legacy accounts require is_internal_funnel.

internal_job_expiration_date

date

Internal posting expiration date in YYYY-MM-DD format. On four-state accounts, the window persists independently of the current sourcing status. Legacy accounts require is_internal_funnel. The expiration action determines the posting status after expiry.

internal_job_expiration_action

integer

enum

Expiration action: 0 = do_not_post, 1 = post_publicly, 2 = intake_closed. Intake closed requires the four-state sourcing model. An action is required when setting a window duration.

Allowed:

go_enabled

boolean | null

When true, enables this opening for Hire Go. Only available when the account has Hire Go enabled and the opening's workflow is go-compatible. Setting go_enabled to true deactivates the opening as part of go-enablement; the opening can be reactivated after Hire Go is configured.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Ok

401Unauthorized

404Not Found

422The sourcing status or the internal window is refused.