FOfountain
Openings and Stages
exposeAsMcpTool

Update opening

Changed on

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.

put/v2/funnels/{id}

Request

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

Path parameters

idstring required

The Opening ID

Request body

activeboolean nullable

Indicator for whether the opening is active

additional_infostring nullable

Additional info about the opening

alternative_localesstring[] nullable

List of alternate locales

compensation_currency_codestring nullable

The currency of the pay rate

compensation_type'hour' | 'day' | 'month' | 'year' nullable

How often the pay occurs

compensationstring nullable

The pay rate

custom_idstring nullable

Identifier custom to opening for the account

hris_idstring nullable

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.

do_launch_portal_from_formboolean nullable

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

external_titlestring nullable

Title that will be show on sourcing and career sites

force_applicant_identityboolean nullable

Indicator for whether applicant identity is enforced

is_hiring_funnelboolean nullable

Indicator for whether the opening is for hiring

is_privateboolean nullable

Indicator for whether the opening is private

is_sourcing_funnelboolean nullable

Indicator for whether the opening is for sourcing

listing_status'public' | 'internal' | 'not_posted' | 'intake_closed'

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.

job_hours'full_time' | 'part_time' nullable

Indicator for whether the opening is full or part time

job_industry'accounting' | 'agriculture' | 'audio_visual' | 'automotive' | 'banking_and_finance' | 'business_operations' | 'construction' | 'consultancy' | 'customer_service_and_call_centres' | 'dental' | 'education_and_training' | 'electronics' | 'energy_oil_and_gas' | 'engineering' | 'environmental_and_waste' | 'facilities_management' | 'food_hospitality' | 'franchise_services' | 'hair_beauty_and_cosmetics' | 'health_medical_and_related' | 'human_resources' | 'insurance' | 'it_and_internet' | 'legal' | 'logistics_procurement_distribution_and_supply_chain' | 'management_executive' | 'manufacturing_and_production' | 'marketing_advertising_and_pr' | 'media_new_media_and_creative' | 'military_and_defence' | 'mining' | 'nonprofit' | 'other' | 'property_and_real-estate' | 'recruitment' | 'retail' | 'sales' | 'scientific_and_pharmaceuticals' | 'secretarial_and_administration' | 'telecommunications' | 'training' | 'travel_leisure_and_tourism' | 'transportation' | 'web_html_info_design' | 'writing_editing' nullable

Industry the opening is for

job_type'permanent' | 'temporary' | 'contract_freelancer' | 'casual' | 'finance_plus_accounting' | 'operations_leadership' | 'all_other_administrative_plus_professional' | 'information_technology' | 'customer_service_plus_operations' | 'local' | 'regional' | 'trainee' | 'shuttle' nullable

The type of job represented by the opening

location_idstring nullable

The unique identifier for the location associated to the opening

owner_idstring nullable

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

position_idstring nullable

The unique identifier for the position associated to the opening

shift_idstring nullable

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

titlestring nullable

The title of the opening

use_obiq_formboolean nullable

Indicator for whether an external application form will be used

workflow_idstring nullable

The unique identifier for the workflow to associate to the opening

is_internal_funnelboolean

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_durationinteger

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_datestring 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_action0 | 1 | 2

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.

go_enabledboolean nullable

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.

Response

Ok

activeboolean required

Indicator for whether the opening is active

go_enabledboolean nullable

When true, indicates this opening is enabled for Hire Go and visible in Hire Go.

additional_infostring nullable

Additional info about the opening

addressstring required

The address of the opening

alternative_localesstring[]

List of alternate locales

apply_urlstring required

The URL with which to apply to the opening

brandstring nullable

The brand the opening is associated with

created_atstring required

Date when the opening was created

custom_idstring nullable

Identifier custom to opening for the account

hris_idstring nullable

ATS job ID. Returned only by the openings index; null when unset.

descriptionstring

The description of the opening

external_titlestring nullable

Title that will be show on sourcing and career sites

force_applicant_identityboolean nullable

Indicator for whether applicant identity is enforced

idstring required

Unique identifier for the opening

is_email_optionalboolean

Indicator for whether email is optional for the opening applicants

is_hiring_funnelboolean required

Indicator for whether the opening is for hiring

is_internal_funnelboolean required

Indicates whether the opening is an internal job posting

is_privateboolean required

Indicator for whether the opening is private

is_sourcing_funnelboolean required

Indicator for whether the opening is for sourcing

is_visible_to_applicantboolean

Indicator for whether the opening is visible for Candidate AI Agent

listing_status'public' | 'internal' | 'not_posted' | 'intake_closed'

Sourcing status. Present only on accounts running the four-state sourcing model.

listing_activation_default'public' | 'internal' | 'not_posted' | 'intake_closed'

Sourcing status selected on activation. Present only on four-state accounts.

listing_deactivation_default'not_posted' | 'intake_closed'

Sourcing status selected on deactivation. Present only on four-state accounts.

internal_job_durationinteger nullable

Internal posting window in days. Present only on four-state accounts.

internal_job_expiration_datestring date nullable

Internal posting expiration date. Present only on four-state accounts.

internal_job_expiration_action0 | 1 | 2 nullable

Expiration action: 0 = do_not_post, 1 = post_publicly, 2 = intake_closed. Present only on four-state accounts.

job_hours'full_time' | 'part_time' nullable

Indicator for whether the opening is full or part time

job_industry'accounting' | 'agriculture' | 'audio_visual' | 'automotive' | 'banking_and_finance' | 'business_operations' | 'construction' | 'consultancy' | 'customer_service_and_call_centres' | 'dental' | 'education_and_training' | 'electronics' | 'energy_oil_and_gas' | 'engineering' | 'environmental_and_waste' | 'facilities_management' | 'food_hospitality' | 'franchise_services' | 'hair_beauty_and_cosmetics' | 'health_medical_and_related' | 'human_resources' | 'insurance' | 'it_and_internet' | 'legal' | 'logistics_procurement_distribution_and_supply_chain' | 'management_executive' | 'manufacturing_and_production' | 'marketing_advertising_and_pr' | 'media_new_media_and_creative' | 'military_and_defence' | 'mining' | 'nonprofit' | 'other' | 'property_and_real-estate' | 'recruitment' | 'retail' | 'sales' | 'scientific_and_pharmaceuticals' | 'secretarial_and_administration' | 'telecommunications' | 'training' | 'travel_leisure_and_tourism' | 'transportation' | 'web_html_info_design' | 'writing_editing' nullable

Industry the opening is for

job_type'permanent' | 'temporary' | 'contract_freelancer' | 'casual' | 'finance_plus_accounting' | 'operations_leadership' | 'all_other_administrative_plus_professional' | 'information_technology' | 'customer_service_plus_operations' | 'local' | 'regional' | 'trainee' | 'shuttle' nullable

The type of job represented by the opening

pay_transparency_requiredboolean

Indicator for whether pay transparency is legally required for this opening's location

pipeline_ratiointeger nullable

Pipeline ratio associated to the opening

requirementsstring

Description of what is required for the opening

time_zonestring required

The timezone of the opening

titlestring

The title of the opening

workflow_idstring nullable

Unique identifier with the workflow associated to the opening

Example response

{
  "opening_pay_rate": {
    "compensation": "20.0"
  }
}

Changes

  • 3119e105004cRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new 2.00 enum value to the request property

    • info

      added the non-success 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

    • 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