Upsert (create/ update) Job Vacancy

Use this endpoint for

  • Creating a new job vacancy in talent marketplace
  • Partially updating an existing job vacancy
  • Fully updating an existing job vacancy in talent marketplace
    • If the vacancy exists, all fields are updated.
    • If the vacancy does not exist, a new vacancy is created.

Note

When using this API to create a vacancy that does not yet exist, the externalId must be provided both:

  • in the path variable, and
  • in the request body.

Typical use cases

  • Keeping job vacancy data in sync with an external source of truth

Localization

  • Updates can be made to one or more language variants of the job vacancy.

Throttling

  • 100 requests/minute

Error descriptions

Error TypesError MessageError Code
Tenanttenant is not an Lx-Galaxy tenant403
Vacancy dataOpportunity not found404
Vacancy Request Body
External Id is missingId is required400
External Id has invalid charactersInvalid external id400
External Id length exceedsLength of externalId exceeds limit400
Job Description is missingAt least one job description is required400
Job Description does not set defaultExactly one job description should be set as default to true400
Multiple jobDescription with same languageMultiple job descriptions for the same language not allowed400
Description is missingJob description: description is required400
Job Details URL is invalidInvalid job details URL400
Apply URL is invalidInvalid apply URL400
Language aCode is invalid and missingJob description: languageCode is invalid and Job description: languageCode is required400
Job Details URL/apply URLEither JobDetailsURL or applyURL is required400
Status is missingStatus is required.400
Status is invalidInvalid job status400
Company name length exceedsLength of company exceeds limit400
Start Date Time formatInvalid start date time format400
End Date Time formatInvalid end date time format400
LocationOnly one of the location can be set to true400
Location Id length exceedsLength of location id exceeds limit400
Location name length exceedsLength of location name exceeds limit400
City length exceedsLength of location city exceeds limit400
CountryCodeInvalid country code400
Region length exceedsLength of location region exceeds limit400
Post Code length exceedsLength of location postCode exceeds limit400
Workplace Model is invalidInvalid workplacemodel400
Job Type is invalidInvalid jobType400
Schedule is invalidInvalid schedule400

Permission required

  • User or integration must have permission to update job vacancies.

OAuth 2.0 Scope: jobvacancy:update

Included features

  • Update of job vacancy metadata and descriptions

Excluded features

  • Partial application workflow updates