job.updateCompensationSettings

Updates compensation display settings for a job.

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

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

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 whose compensation display settings to update

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

Whether compensation should appear on individual job postings. Omit to leave unchanged. Pass null to clear the override and inherit from the brand. 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 brand.

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 brand.

Response

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