API Reference

jobPosting.create

post
https://api.ashbyhq.com/jobPosting.create

Creates a new job posting for the specified job.

Only jobId is required. When title is omitted the posting inherits the parent job's title. When status is omitted the posting is created in Draft status.

Side effects:

  • The new posting is always attached to the external job board for the parent job's brand. This board cannot be overridden today, and this endpoint cannot create a posting on an internal job board.
  • isListed controls whether the posting is listed on that external job board. It defaults to true when omitted. Setting it to false leaves the posting attached to the board.
  • If no default posting exists for the parent job, this posting becomes the default.
  • When the parent job is confidential, isListed is forced to false regardless of the value provided.

Requires the jobsWrite permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

The id of the job to create a posting for

string

The title for the new job posting. If omitted, defaults to the parent job's title.

description
object

An HTML block of the job posting description

string
enum

The type of workplace

Allowed:
string
enum

The initial status of the job posting. Defaults to Draft if omitted. A description is required when creating a Published posting.

Allowed:
boolean

Whether the posting should be listed on the job board. Defaults to true and is forced to false when the parent job is confidential.

uuid
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

The id of the primary location for the job posting. If omitted, the posting inherits the parent job's location.

secondaryLocationIds
array of uuids

The secondary locations for the job posting.

secondaryLocationIds
uuid
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

The id of the application form definition to use for the posting. If omitted, the organization default form is used.

Response

Updated about 22 hours ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 22 hours ago