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

# Create or Update a Job



## OpenAPI

````yaml POST /job
openapi: 3.0.1
info:
  title: Ready Health API
  description: ''
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.readyhealth.com
security:
  - ApiKeyAuth: []
paths:
  /job:
    post:
      summary: Create or update a job
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewJob'
      responses:
        '201':
          description: Job created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
components:
  schemas:
    NewJob:
      type: object
      required:
        - vmsType
        - vmsJobRefId
      properties:
        vmsType:
          type: string
          description: Pre-configured VMS platform key.
        vmsJobRefId:
          type: string
          description: Job ID in the VMS.
        title:
          type: string
        facility:
          type: string
        location:
          type: string
        department:
          type: string
        role:
          type: string
        atsJobRefId:
          type: string
          description: Job ID in the ATS.
        atsSystem:
          type: string
          description: Pre-configured ATS platform key.
    Job:
      type: object
      properties:
        id:
          type: string
          format: uuid
        vmsJobRefId:
          type: string
        atsJobRefId:
          type: string
          nullable: true
        atsSystem:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        facility:
          type: string
          nullable: true
        location:
          type: string
          nullable: true
        department:
          type: string
          nullable: true
        role:
          type: string
          nullable: true
        status:
          $ref: '#/components/schemas/JobStatus'
        vmsIntegration:
          type: object
          properties:
            id:
              type: string
              format: uuid
            vmsType:
              type: string
            displayName:
              type: string
              nullable: true
        requirementCount:
          type: integer
        mappedCount:
          type: integer
        requirements:
          type: array
          items:
            $ref: '#/components/schemas/JobRequirement'
        placementCount:
          type: integer
        scrapeQueued:
          type: boolean
          description: >-
            Only on `POST /job`. `false` when the job is `UNAVAILABLE` and
            `force` was not set.
    JobStatus:
      type: string
      enum:
        - ACTIVE
        - FILLED
        - CLOSED
        - UNAVAILABLE
    JobRequirement:
      type: object
      properties:
        id:
          type: string
          format: uuid
        vmsRequirementName:
          type: string
        packetGroup:
          type: string
          nullable: true
        fulfillmentType:
          $ref: '#/components/schemas/FulfillmentType'
        documentCategory:
          type: string
          nullable: true
        documentType:
          type: string
          nullable: true
        status:
          $ref: '#/components/schemas/RequirementStatus'
        isMapped:
          type: boolean
        sortOrder:
          type: integer
    FulfillmentType:
      type: string
      enum:
        - DOCUMENT
        - REGISTRY_SEARCH
        - STATEMENT
        - PASS_THROUGH
    RequirementStatus:
      type: string
      enum:
        - PENDING
        - AWAITING_CONFIG
        - IN_PROGRESS
        - FULFILLED
        - REJECTED
        - INVALIDATED
        - EXPIRED
        - SKIPPED
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````