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

# Update a job

> Apply a partial (dimension-scoped) update to a job. Submit any non-empty subset of the allowed dimensions — `information`, `experience_preference`, `education_preference`, `hard_skills`, `soft_skills` — and only those will be processed and persisted. Unspecified dimensions are left untouched. The candidate-shape aliases `experience` and `education` are also accepted and rewritten internally to the canonical Vacancy names. `content_language` is required on every patch (whether the body touches text or skills dimensions); it can also be supplied via the `Accept-Language` request header, which the API auto-forwards. The 200 response echoes the full merged Job entity (with `created_at` / `updated_at` populated from the local task row), so the caller does not need a follow-up `GET /jobs/{id}`.



## OpenAPI

````yaml /api-reference/openapi.json put /jobs/{id}
openapi: 3.1.0
info:
  title: Fribl API
  description: >-
    The Fribl API enables intelligent talent matching powered by AI. Analyze CVs
    and job descriptions from text or file uploads, search and manage skills,
    match candidates to positions with configurable scoring weights, and source
    candidate profiles from external databases. All document processing is
    asynchronous — submit documents for analysis, poll for status, and retrieve
    structured results when ready.
  version: 1.0.0
  contact:
    name: Fribl Support
    url: https://fribl.co
servers:
  - url: https://api-service.fribl.co/api/v1
    description: Production
security:
  - apiKey: []
tags:
  - name: CVs
    description: >-
      Upload, analyze, retrieve, update, and delete candidate CVs. CVs can be
      submitted as raw text or as PDF file uploads. Processing is asynchronous —
      use the status endpoint to track progress.
  - name: Jobs
    description: >-
      Upload, analyze, retrieve, update, and delete job descriptions. Jobs can
      be submitted as raw text or as PDF file uploads. Processing is
      asynchronous — use the status endpoint to track progress.
  - name: Matching
    description: >-
      Match analyzed CVs against job descriptions using AI-powered scoring.
      Configure weights across experience, hard skills, soft skills, and
      education dimensions to tailor match results to your hiring priorities.
  - name: Sourcing
    description: >-
      Search for candidate profiles from external sources, retrieve cached
      search results, and ingest selected profiles into your Fribl workspace for
      matching.
  - name: Skills
    description: >-
      Search the Fribl skills taxonomy and retrieve available languages for
      skill translation. These endpoints are publicly accessible and do not
      require authentication.
  - name: Tokens
    description: >-
      Inspect your workspace's usage-based token balance, review the ledger of
      every charge and refund, and read the live per-action price list. Billable
      endpoints deduct tokens and return 402 when the balance is insufficient.
      Tokens are purchased and managed in the Fribl Console
      (https://console.fribl.co).
paths:
  /jobs/{id}:
    put:
      tags:
        - Jobs
      summary: Update a job
      description: >-
        Apply a partial (dimension-scoped) update to a job. Submit any non-empty
        subset of the allowed dimensions — `information`,
        `experience_preference`, `education_preference`, `hard_skills`,
        `soft_skills` — and only those will be processed and persisted.
        Unspecified dimensions are left untouched. The candidate-shape aliases
        `experience` and `education` are also accepted and rewritten internally
        to the canonical Vacancy names. `content_language` is required on every
        patch (whether the body touches text or skills dimensions); it can also
        be supplied via the `Accept-Language` request header, which the API
        auto-forwards. The 200 response echoes the full merged Job entity (with
        `created_at` / `updated_at` populated from the local task row), so the
        caller does not need a follow-up `GET /jobs/{id}`.
      operationId: updateJob
      parameters:
        - name: id
          in: path
          required: true
          description: Unique identifier of the job to update.
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JobUpdateBody'
      responses:
        '200':
          description: >-
            Job updated successfully. `data` contains the full merged Job entity
            (the patch applied on top of the existing record), with `created_at`
            and `updated_at` populated from the local task row.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: >-
                      Successfully updated Job with ID:
                      550e8400-e29b-41d4-a716-446655440000
                  data:
                    $ref: '#/components/schemas/Job'
                required:
                  - message
                  - data
        '400':
          description: >-
            Update validation failed. The response may include `detail.message`
            and `detail.invalid_skills`.
          content:
            application/json:
              examples:
                missingContentLanguage:
                  value:
                    detail:
                      message: >-
                        content_language is required and must be a valid ISO
                        639-1 language code.
                invalidSkills:
                  value:
                    detail:
                      message: Update validation failed.
                      invalid_skills:
                        - id: not-a-real-skill-id
                          field: hard_skills
                          message: >-
                            Skill does not exist in the canonical
                            graph/taxonomy.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          description: The submitted body does not match the expected job update schema.
          content:
            application/json:
              example:
                detail:
                  message: >-
                    Payload does not match VacancyUpdate schema for
                    entity_type=Vacancy.
                  schema: VacancyUpdate
                  errors:
                    - type: missing
                      loc:
                        - information
                        - title
                      msg: Field required
components:
  schemas:
    JobUpdateBody:
      type: object
      description: >-
        Partial (dimension-scoped) update for a job. Submit any non-empty subset
        of the allowed dimensions — `information`, `experience_preference`,
        `education_preference`, `hard_skills`, `soft_skills` — and only those
        will be processed and persisted. Unspecified dimensions are left
        untouched. The candidate-shape aliases `experience` and `education` are
        also accepted and rewritten internally to the canonical Vacancy names
        (`experience_preference`, `education_preference`) before validation.
        `content_language` is required on every patch (text or skills
        dimensions); it can also be supplied via the `Accept-Language` request
        header, in which case the body field can be omitted.
      properties:
        content_language:
          type: string
          description: >-
            ISO 639-1 language code of the submitted update payload. Required on
            every patch unless the `Accept-Language` header is set — the API
            forwards that header automatically. Without either, the request is
            rejected with 400.
        information:
          $ref: '#/components/schemas/JobInformation'
        experience_preference:
          $ref: '#/components/schemas/JobExperiencePreference'
        education_preference:
          $ref: '#/components/schemas/JobEducationPreference'
        experience:
          $ref: '#/components/schemas/JobExperiencePreference'
          description: >-
            Alias for `experience_preference`. Accepted for callers using the
            candidate-shape vocabulary; rewritten internally.
        education:
          $ref: '#/components/schemas/JobEducationPreference'
          description: >-
            Alias for `education_preference`. Accepted for callers using the
            candidate-shape vocabulary; rewritten internally.
        hard_skills:
          type: array
          items:
            $ref: '#/components/schemas/Skill'
          description: >-
            Updated hard skills. Skill IDs must already exist in the canonical
            taxonomy.
        soft_skills:
          type: array
          items:
            $ref: '#/components/schemas/Skill'
          description: >-
            Updated soft skills. Skill IDs must already exist in the canonical
            taxonomy.
      anyOf:
        - required:
            - information
        - required:
            - experience_preference
        - required:
            - education_preference
        - required:
            - experience
        - required:
            - education
        - required:
            - hard_skills
        - required:
            - soft_skills
    Job:
      type: object
      description: A fully analyzed job description with extracted structured data.
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the job.
        information:
          $ref: '#/components/schemas/JobInformation'
        experience_preference:
          $ref: '#/components/schemas/JobExperiencePreference'
        education_preference:
          $ref: '#/components/schemas/JobEducationPreference'
        job_requirements:
          type: array
          items:
            type: string
          description: List of job requirements extracted from the description.
          example:
            - 5+ years experience
            - Strong communication
        source_language:
          type: string
          description: Original content language associated with this job.
        hard_skills:
          type: array
          items:
            $ref: '#/components/schemas/Skill'
          description: Structured hard skills identified from the job description.
        soft_skills:
          type: array
          items:
            $ref: '#/components/schemas/Skill'
          description: Structured soft skills identified from the job description.
        created_at:
          type: string
          format: date-time
          description: Timestamp when the job was created.
          example: '2024-01-01T00:00:00.000Z'
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the job was last updated.
          example: '2024-01-01T00:00:00.000Z'
    JobInformation:
      type: object
      description: Core information about a job posting.
      properties:
        title:
          type: string
          description: Job title.
          example: Senior Software Engineer
        company:
          type: string
          description: Name of the hiring company.
          example: Tech Corp
        description:
          type: string
          description: Full job description text.
          example: We are looking for...
        activity_sector:
          type: string
          description: Industry or sector of the company.
          example: Technology
        locations:
          type: array
          items:
            $ref: '#/components/schemas/Address'
          description: List of job locations.
        job_type:
          type: string
          description: Type of employment (e.g., Full-time, Part-time).
          example: Full-time
        contract_type:
          type: string
          description: Type of contract (e.g., Permanent, Temporary, Freelance).
          example: Permanent
    JobExperiencePreference:
      type: object
      description: Preferred experience criteria for the job.
      properties:
        title:
          type: string
          description: Preferred previous job title.
          example: Software Engineer
        activity_sector:
          type: string
          description: Preferred industry or sector.
          example: Technology
        description:
          type: string
          description: Description of preferred experience.
          example: Experience in backend development
        duration:
          type: integer
          description: Preferred minimum experience duration in months.
          example: 60
    JobEducationPreference:
      type: object
      description: Preferred education criteria for the job.
      properties:
        degree:
          type: string
          description: Preferred degree level.
          example: Master of Science
        major:
          type: string
          description: Preferred field of study.
          example: Computer Science
        score:
          type: string
          description: Preferred grade or distinction.
          example: ''
    Skill:
      type: object
      description: >-
        A skill identified from a CV or job description, with type
        classification and match relationship.
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the skill.
        skill:
          type: string
          description: Name of the skill.
          example: JavaScript
        type:
          type: string
          enum:
            - hard-skill
            - soft-skill
          description: >-
            Canonical English type enum for the skill. This field is not
            translated.
        relationship:
          type: string
          enum:
            - required
            - optional
            - satisfies
          description: >-
            Canonical English relationship enum for the associated CV or job.
            This field is not translated.
        explanation:
          type:
            - string
            - 'null'
          description: >-
            AI-generated explanation of how this skill was identified or
            evaluated.
          example: Candidate demonstrates strong JavaScript proficiency
    ErrorResponse:
      type: object
      description: Standard error response.
      properties:
        error:
          type: string
          description: Human-readable error message.
      required:
        - error
    Address:
      type: object
      description: A geographic address.
      properties:
        city:
          type: string
          description: City name.
          example: Amsterdam
        country:
          type: string
          description: Country name.
          example: Netherlands
  responses:
    Unauthorized:
      description: >-
        Authentication failed. Provide a valid API key in the `x-api-key`
        header.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key in UUID format. Include this header with every authenticated
        request.

````