Skip to main content
PATCH
Patch job description

Authorizations

x-api-key
string
header
required

API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.

Path Parameters

id
string
required

Body

application/json
format
enum<string>

The format this job description is expected to be in. When provided and it does not match the stored format the request is rejected; convert the job description first. Omit to patch whatever format it currently has.

Available options:
FREEFORM,
STRUCTURED
content
string | null

The HTML content of the job description. Omit to leave unchanged; set to null to clear it.

Maximum string length: 300000
Example:

"<p>We are looking for a senior software engineer...</p>"

externalJobTitle
string

The externally visible job title for this job. Omit to leave unchanged.

Minimum string length: 1
Example:

"Senior Software Engineer"

language
enum<string>

The language to set on this job description. Omit to leave unchanged.

Available options:
en-US,
en-GB,
es,
nl,
fr,
de,
hu,
cs,
pt,
no,
sv,
da,
fi,
pl,
ro,
it,
af,
cy,
ja
requirements
string | null

The Requirements block HTML (STRUCTURED jobs only). Omit to leave unchanged; set to null to clear it.

Maximum string length: 100000
description
string | null

The Description block HTML (STRUCTURED jobs only). Omit to leave unchanged; set to null to clear it.

Maximum string length: 100000
compensation
string | null

The Compensation block HTML (STRUCTURED jobs only). Omit to leave unchanged; set to null to clear it.

Maximum string length: 100000

Response

Job description updated successfully