Update opening

put

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

Update an existing Opening. 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

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

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 funnel is an internal job posting. When true, the job is visible only to internal users unless is_sourcing_funnel is also true. Supports all combinations with is_sourcing_funnel for public/internal posting modes.

internal_job_duration

integer

Specifies the number of days the internal job remains active after approval or activation. Used only when is_internal_funnel is true. Ignored for active funnels that already specify an internal_job_expiration_date. Allowed values represent 1–14-day durations (1, 2, 3, 7, or 14 days).

internal_job_expiration_date

date

Explicit expiration date for the internal job posting in ISO-8601 date format (YYYY-MM-DD). Valid only when is_internal_funnel is true and must be today or a future date. Required if internal_job_expiration_action is provided. Once this date passes, the internal funnel is automatically deactivated by background job processing.

internal_job_expiration_action

integer

enum

Determines the funnel’s behavior when the internal posting expires. 0 = do_not_post (disable both internal and public posting). 1 = post_publicly (keep public posting enabled, disable only internal). Required if internal_job_expiration_date is set. Optional when using internal_job_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

200Ok

401Unauthorized

404Not Found