Workday Recruiting · JSON Structure

Recruiting Rest Api Offer Create Structure

Request body for initiating an employment offer

Type: object Properties: 5 Required: 1
HCMHuman ResourcesRecruitingSaaSTalent Acquisition

OfferCreate is a JSON Structure definition published by Workday Recruiting, describing 5 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

proposedStartDate compensationAmount compensationFrequency currency expirationDate

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/workday-recruiting/refs/heads/main/json-structure/recruiting-rest-api-offer-create-structure.json",
  "name": "OfferCreate",
  "description": "Request body for initiating an employment offer",
  "type": "object",
  "properties": {
    "proposedStartDate": {
      "type": "date",
      "description": "Proposed start date for employment",
      "example": "2026-05-03"
    },
    "compensationAmount": {
      "type": "double",
      "description": "Offered compensation amount",
      "example": 120000.0
    },
    "compensationFrequency": {
      "type": "string",
      "enum": [
        "Annual",
        "Hourly",
        "Monthly"
      ],
      "description": "Compensation frequency",
      "example": "Annual"
    },
    "currency": {
      "type": "object",
      "description": "A reference to a related Workday resource",
      "properties": {
        "id": {
          "type": "string",
          "description": "Workday ID (WID) of the referenced resource",
          "example": "11111111-2222-3333-4444-555555555555"
        },
        "descriptor": {
          "type": "string",
          "description": "Display name of the referenced resource",
          "example": "Senior Software Engineer"
        }
      }
    },
    "expirationDate": {
      "type": "date",
      "description": "Date the offer expires",
      "example": "2026-05-03"
    }
  },
  "required": [
    "proposedStartDate"
  ]
}