Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Job Posting

jobPosting.update

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

Note on updating the description: When job description openings and closings are not suppressed, the descriptionHtml field returned in jobPosting.info may contain content that is not modifiable through the API. Only the content of the descriptionParts.descriptionBody field of the jobPosting.info endpoint is modifiable through this call. To completely customize the description, set both suppressDescriptionOpening and suppressDescriptionClosing to true.

Requires the jobsWrite permission.

post/jobPosting.update

Request body

jobPostingIdstring uuid required

The unique id of the job posting to update

titlestring nullable

A new title for the job posting

workplaceType'OnSite' | 'Hybrid' | 'Remote' nullable

The type of workplace

suppressDescriptionOpeningboolean nullable

When true, the job description opening from the brand will be suppressed. descriptionOpening will be returned as null.

suppressDescriptionClosingboolean nullable

When true, the job description closing from the brand will be suppressed. descriptionClosing will be returned as null.

includeUnpublishedJobPostingsboolean nullable

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

Example request

{
  "jobPostingId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "title": "Software Engineer",
  "suppressDescriptionOpening": true,
  "suppressDescriptionClosing": true
}

Response

Responses from the jobPosting.update 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
  }
}