API Reference

jobPosting.updateCompensationSettings

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

Updates compensation display settings for a job posting.

Controls whether and how compensation is shown for this specific posting. Each field uses the null-means-inherit convention:

  • Omitted: leaves the current setting untouched.
  • Explicit null: clears the posting-level override so the value inherits from the parent job.
  • Any other value: sets a posting-level override.

Set includeUnpublishedJobPostings to true when updating an unpublished (draft) job posting.

Note: organization-level pay transparency settings (e.g. globalRequiredOnPostings) can force compensation display on regardless of these settings. The configured values may therefore differ from the computed display behavior visible to candidates.

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 unique id of the job posting whose compensation display settings to update

Whether compensation should appear on the job board listing for this posting. Omit to leave unchanged. Pass null to clear the override and inherit from the parent job.

Whether compensation should appear on this posting's detail page. Omit to leave unchanged. Pass null to clear the override and inherit from the parent job. Note: organization-level pay transparency settings can force this on regardless.

A URL explaining the compensation tiers. Omit to leave unchanged. Pass null to clear the override and inherit from the parent job.

CompensationPhilosophyInput | null

The compensation philosophy as a { type, value } object using text/plain or text/html. Omit to leave unchanged. Pass null to clear the override and inherit from the parent job.

When true, allows updating an unpublished (draft) job posting. Required when updating a draft posting.

Response

Updated about 18 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 18 hours ago