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.

Locations: Use locationId to set or clear the primary posting location. Pass null to clear the override and fall back to the parent job's location. Use secondaryLocationIds to fully replace the set of secondary locations. Pass an empty array to remove all secondary locations.

Application form: Use applicationFormDefinitionId to set or clear the posting's application form override. Pass null to fall back to the organization default form.

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 to update

A new title for the job posting

enum

The type of workplace

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

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

object | null

An HTML block of the job posting description

^([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 email template to use for application confirmation emails on this posting. Pass null to clear the posting-level override and fall back to organization defaults.

^([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 location to set as the primary location for the job posting. Pass null to clear the posting-level location override so the posting falls back to the parent job's location.

secondaryLocationIds
array of uuids

A full replacement of the secondary locations for the job posting. Pass an empty array to clear all secondary locations.

secondaryLocationIds
^([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 this posting. Pass null to clear the posting-level override and fall back to the organization default form.

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

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