Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Job Posting

jobPosting.updateCompensation

Updates compensation for an existing job posting.

Set includeUnpublishedJobPostings to true when updating an unpublished (draft) job posting. This flag is required for draft postings; published postings can be updated without it.

Pass a non-empty compensationTiers array to replace the posting's compensation and stop inheriting compensation from the parent job. Pass null to reset the posting to inherit compensation from the parent job.

Requires the jobsWrite permission.

post/jobPosting.updateCompensation

Request body

jobPostingIdstring uuid required

The unique id of the job posting to update

includeUnpublishedJobPostingsboolean nullable

When true, allows updating compensation for unpublished (draft) job postings. Required when updating a draft posting.

Example request

{
  "jobPostingId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "compensationTiers": [
    {
      "title": "Zone A",
      "additionalInformation": "Signing bonus available",
      "components": [
        {
          "compensationType": "Salary",
          "interval": "1 YEAR",
          "currencyCode": "EUR",
          "minValue": 72023.45,
          "maxValue": 100000
        }
      ]
    }
  ]
}

Response

Responses from the jobPosting.updateCompensation endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "title": "Software Engineer",
    "descriptionPlain": "This role will build and maintain customer-facing software.",
    "descriptionHtml": "<p>This role will build and maintain customer-facing software.</p>",
    "descriptionSocial": null,
    "descriptionParts": {
      "descriptionOpening": null,
      "descriptionBody": {
        "html": "<p>This role will build and maintain customer-facing software.</p>",
        "plain": "This role will build and maintain customer-facing software."
      },
      "descriptionClosing": null
    },
    "departmentName": "Engineering",
    "teamName": "Product Engineering",
    "teamNameHierarchy": [
      "Engineering",
      "Product Engineering"
    ],
    "jobId": "8cfb4f68-4d1f-4f8b-9b2f-1f3f2c945f3d",
    "locationName": "San Francisco",
    "locationAddress": "San Francisco, California, United States",
    "locationIds": {
      "primaryLocationId": "7bb8f10f-12d0-4d26-8d08-0f432a67b123",
      "secondaryLocationIds": []
    },
    "linkedData": {},
    "publishedDate": "2024-01-15",
    "applicationDeadline": null,
    "address": {
      "postalAddress": {
        "addressRegion": "California",
        "addressCountry": "United States",
        "addressLocality": "San Francisco"
      }
    },
    "isRemote": false,
    "workplaceType": "OnSite",
    "employmentType": "FullTime",
    "applicationFormDefinition": {},
    "surveyFormDefinitions": [],
    "isListed": true,
    "suppressDescriptionOpening": false,
    "suppressDescriptionClosing": false,
    "externalLink": "https://jobs.ashbyhq.com/example/e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "applyLink": "https://jobs.ashbyhq.com/example/e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "compensation": {
      "compensationTierSummary": "$100K - $120K",
      "summaryComponents": [
        {
          "summary": "$100K - $120K",
          "compensationType": "Salary",
          "interval": "1 YEAR",
          "currencyCode": "USD",
          "minValue": 100000,
          "maxValue": 120000
        }
      ],
      "compensationTiers": [
        {
          "id": "7acaf4b2-fbd2-47f9-8d09-222a3a469da1",
          "tierSummary": "$100K - $120K",
          "title": null,
          "additionalInformation": null,
          "components": [
            {
              "id": "e58d5b1e-6fc7-4df4-a418-e4f746235db7",
              "summary": "$100K - $120K",
              "compensationType": "Salary",
              "interval": "1 YEAR",
              "currencyCode": "USD",
              "minValue": 100000,
              "maxValue": 120000
            }
          ]
        }
      ],
      "shouldDisplayCompensation": true
    },
    "updatedAt": "2024-01-15T10:30:00.000Z",
    "applicationLimitCalloutHtml": null
  }
}