> ## Documentation Index
> Fetch the complete documentation index at: https://docs.spott.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Patch job description

> Partially update a single job description. Any subset of the external job title, content, blocks and language may be provided; omitted fields are left unchanged. Content is only accepted for FREEFORM job descriptions and blocks only for STRUCTURED ones. Changing the language fails if another job description already exists for that job and language.



## OpenAPI

````yaml /api-reference/openapi.json patch /job-descriptions/{id}
openapi: 3.1.0
info:
  title: Spott API Reference
  version: '0.1'
servers:
  - url: https://api.gospott.com
security: []
tags: []
paths:
  /job-descriptions/{id}:
    patch:
      tags:
        - Job Descriptions
      summary: Patch job description
      description: >-
        Partially update a single job description. Any subset of the external
        job title, content, blocks and language may be provided; omitted fields
        are left unchanged. Content is only accepted for FREEFORM job
        descriptions and blocks only for STRUCTURED ones. Changing the language
        fails if another job description already exists for that job and
        language.
      operationId: patchJobDescriptionById
      parameters:
        - name: id
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchJobDescriptionDto'
      responses:
        '204':
          description: Job description updated successfully
        '400':
          description: No fields provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseDto'
        '401':
          description: Unauthorized - invalid or missing authentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseDto'
        '404':
          description: Job description not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseDto'
        '409':
          description: >-
            A job description already exists for this job and language, or the
            provided format does not match the stored format
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseDto'
        '500':
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseDto'
      security:
        - x-api-key: []
components:
  schemas:
    PatchJobDescriptionDto:
      type: object
      properties:
        format:
          description: >-
            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.
          type: string
          enum:
            - FREEFORM
            - STRUCTURED
        content:
          description: >-
            The HTML content of the job description. Omit to leave unchanged;
            set to null to clear it.
          example: <p>We are looking for a senior software engineer...</p>
          anyOf:
            - type: string
              maxLength: 300000
            - type: 'null'
        externalJobTitle:
          description: >-
            The externally visible job title for this job. Omit to leave
            unchanged.
          example: Senior Software Engineer
          type: string
          minLength: 1
        language:
          $ref: '#/components/schemas/DmSpottSupportedUserAiLanguage'
          description: >-
            The language to set on this job description. Omit to leave
            unchanged.
        requirements:
          description: >-
            The Requirements block HTML (STRUCTURED jobs only). Omit to leave
            unchanged; set to null to clear it.
          anyOf:
            - type: string
              maxLength: 100000
            - type: 'null'
        description:
          description: >-
            The Description block HTML (STRUCTURED jobs only). Omit to leave
            unchanged; set to null to clear it.
          anyOf:
            - type: string
              maxLength: 100000
            - type: 'null'
        compensation:
          description: >-
            The Compensation block HTML (STRUCTURED jobs only). Omit to leave
            unchanged; set to null to clear it.
          anyOf:
            - type: string
              maxLength: 100000
            - type: 'null'
      id: PrivatePatchJobDescriptionDto
    ExceptionBaseDto:
      type: object
      properties:
        status:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        message:
          type: string
        requestId:
          type: string
      required:
        - status
        - message
        - requestId
      id: ExceptionBaseDto
    DmSpottSupportedUserAiLanguage:
      type: string
      enum:
        - en-US
        - en-GB
        - es
        - nl
        - fr
        - de
        - hu
        - cs
        - pt
        - 'no'
        - sv
        - da
        - fi
        - pl
        - ro
        - it
        - af
        - cy
        - ja
      id: DmSpottSupportedUserAiLanguage
  securitySchemes:
    x-api-key:
      type: apiKey
      name: x-api-key
      in: header
      description: >-
        API key for authentication. Get your API key from Settings → API Keys in
        your Spott dashboard.

````