API Reference

Create an opening

post
https://services.fountain.com/api/servicehire/v2/funnels

Create an opening using the supplied details.

Create a new 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.

Body Params
boolean | null

Indicator for whether the opening is active

string | null

Additional info about the opening

alternative_locales
array of strings | null

List of alternate locales

alternative_locales
string | null

The unique identifier for a workflow to clone and then associate the clone to the opening

string | null

The currency of the pay rate

string | null
enum

How often the pay occurs

Allowed:
string | null

The pay rate

string | null

Identifier custom to opening for the account

string | null

ATS job ID. Set once and unique among live openings in the account. Blank values are treated as unset.

customer_attributes
array of objects | null

List of customer attributes for the opening

customer_attributes
boolean | null

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

string | null

Title that will be show on sourcing and career sites

boolean | null

Indicator for whether applicant identity is enforced

boolean | null

Indicator for whether the opening is for hiring

boolean | null

Indicator for whether the opening is private

boolean | null

Indicator for whether the opening is for sourcing

string
enum

Sourcing status on an account running the four-state model. Ignored on legacy accounts. Public and Internal require an active opening; Internal also requires the internal career site. When sent, it takes precedence over is_sourcing_funnel, is_internal_funnel and unlisted_from_sourcing, and a Public or Internal status also becomes the opening's activation default. When the account creates the opening inactive for Hire Go, a Public or Internal status becomes only the activation default. When omitted, existing posting fields determine the status.

Allowed:
integer
enum

Internal posting window in days. On four-state accounts, the window starts when the opening becomes Internal.

Allowed:
date

Internal posting expiration date in YYYY-MM-DD format.

integer
enum

Expiration action: 0 = do_not_post, 1 = post_publicly, 2 = intake_closed. Intake closed requires the four-state sourcing model.

Allowed:
string | null
enum

Indicator for whether the opening is full or part time

Allowed:
string | null
enum

Industry the opening is for

string | null
enum

The type of job represented by the opening

string
required

The unique identifier for the location associated to the opening

string | null

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

string
required

The unique identifier for the position associated to the opening

shift_attributes
object

The values to define a new shift for the opening

string | null

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

string
required

The title of the opening

boolean | null

Indicator for whether an external application form will be used

boolean | null

Indicator for whether to create a new workflow based on the opening

workflow_attributes
object | null

Provide override values for workflow being created or cloned. For use in combination with "use_workflow" or "clone_workflow_id"

string | null

The unique identifier for the workflow to associate to the opening

Responses

Updated 5 days ago

Did this page help you?
Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 days ago

Did this page help you?