{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aiapplyd/main/json-schema/aiapplyd-patch-user-preferences-schema.json",
  "title": "PatchUserPreferences",
  "x-generated": "2026-09-23",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/aiapplyd-openapi.yml#/components/schemas/PatchUserPreferences",
  "type": "object",
  "properties": {
    "applicationProfile": {
      "type": "object",
      "properties": {
        "phone": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 20,
          "description": "Phone number"
        },
        "addressLine1": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 255,
          "description": "Address line 1"
        },
        "addressLine2": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 255,
          "description": "Address line 2"
        },
        "city": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 100,
          "description": "City"
        },
        "state": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 100,
          "description": "State or province"
        },
        "zipCode": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 20,
          "description": "ZIP or postal code"
        },
        "country": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 100,
          "description": "Country"
        },
        "linkedinUrl": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 500,
          "format": "uri",
          "description": "LinkedIn profile URL"
        },
        "portfolioUrl": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 500,
          "format": "uri",
          "description": "Portfolio website URL"
        },
        "githubUrl": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 500,
          "format": "uri",
          "description": "GitHub profile URL"
        },
        "currentEmployer": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 120,
          "description": "Current employer / company. Helps tailor recommendations; unlocks team analytics if the company onboards."
        },
        "dateOfBirth": {
          "type": [
            "string",
            "null"
          ],
          "description": "Date of birth (ISO 8601 date string)"
        },
        "workAuthorization": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "us_citizen",
            "permanent_resident",
            "visa_holder",
            "require_sponsorship",
            "other",
            null
          ],
          "description": "Work authorization status"
        },
        "willingToRelocate": {
          "type": "boolean",
          "description": "Willing to relocate for a job"
        },
        "relocationLocations": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          },
          "description": "Preferred relocation locations as \"City, Country\" or \"Country\" (max per-entry stripping of middle admin segments on ingest)."
        },
        "salaryCurrency": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "usd",
            "eur",
            "gbp",
            "cad",
            "aud",
            "inr",
            null
          ],
          "description": "Salary currency"
        },
        "availableStartDate": {
          "type": [
            "string",
            "null"
          ],
          "description": "Earliest available start date (ISO 8601 date string)"
        },
        "noticePeriod": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "immediately",
            "two_weeks",
            "one_month",
            "two_months",
            "three_months",
            "flexible",
            null
          ],
          "description": "Notice period before starting new position"
        },
        "personalNarrative": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 500,
          "description": "Free-form narrative about gaps / transitions / short stints. Drives interview-prep red-flag question generation (F8)."
        },
        "travelWillingness": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "none",
            "up_to_25",
            "up_to_50",
            "up_to_75",
            "up_to_100",
            null
          ],
          "description": "Willingness to travel for work"
        },
        "securityClearance": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "none",
            "confidential",
            "secret",
            "top_secret",
            "ts_sci",
            "prefer_not_to_say",
            null
          ],
          "description": "Security clearance level"
        },
        "restrictiveCovenantStatus": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "yes",
            "no",
            "prefer_not_to_say",
            null
          ],
          "description": "Currently subject to a non-compete / non-solicit / restrictive covenant with a former employer"
        },
        "criminalRecordStatus": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "yes",
            "no",
            "prefer_not_to_say",
            null
          ],
          "description": "Has a criminal conviction they are legally required to disclose"
        },
        "backgroundCheckConsent": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "yes",
            "no",
            "prefer_not_to_say",
            null
          ],
          "description": "Consents to a background / reference / credit check or drug screen where the role requires one"
        },
        "relatedToEmployeeStatus": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "yes",
            "no",
            "prefer_not_to_say",
            null
          ],
          "description": "Has a family member or close personal relationship with an employee of a company they apply to. Global, not per-employer: only a \"no\" is committable on a form."
        },
        "exportControlUsPerson": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "yes",
            "no",
            "prefer_not_to_say",
            null
          ],
          "description": "Is a U.S. person for export-control (ITAR / EAR) purposes. The only declaration whose \"yes\" is the permissive answer."
        },
        "highestEducation": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "high_school",
            "associate",
            "bachelor",
            "master",
            "doctorate",
            "any",
            null
          ],
          "description": "Highest education level completed"
        },
        "yearsOfExperience": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 50,
          "description": "Total years of professional experience"
        },
        "veteranStatus": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "not_a_veteran",
            "veteran",
            "disabled_veteran",
            "recently_separated_veteran",
            "active_duty_wartime_veteran",
            "armed_forces_service_medal_veteran",
            "prefer_not_to_say",
            null
          ],
          "description": "Veteran status for EEO forms"
        },
        "disabilityStatus": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "yes",
            "no",
            "prefer_not_to_say",
            null
          ],
          "description": "Disability status for EEO forms"
        },
        "gender": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "male",
            "female",
            "non_binary",
            "prefer_not_to_say",
            "other",
            null
          ],
          "description": "Gender for EEO forms"
        },
        "ethnicity": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "american_indian_or_alaska_native",
            "asian",
            "black_or_african_american",
            "hispanic_or_latino",
            "native_hawaiian_or_pacific_islander",
            "white",
            "two_or_more_races",
            "prefer_not_to_say",
            "other",
            null
          ],
          "description": "Ethnicity for EEO forms"
        },
        "sexualOrientation": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "heterosexual",
            "gay_or_lesbian",
            "bisexual",
            "prefer_not_to_say",
            "other",
            null
          ],
          "description": "Sexual orientation for EEO forms"
        },
        "pronouns": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 40,
          "description": "Preferred pronouns, self-described free text"
        }
      },
      "additionalProperties": false,
      "description": "Partial application_profile patch. Only provided fields are updated."
    },
    "jobMatchPreferences": {
      "type": "object",
      "properties": {
        "benefits": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Must-have job benefits"
        },
        "companySize": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Preferred company sizes"
        },
        "educationLevel": {
          "type": "string",
          "description": "Minimum education level filter"
        },
        "excludeIndustries": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Industries to exclude from matches"
        },
        "experienceLevel": {
          "type": "string",
          "enum": [
            "entry",
            "mid",
            "senior",
            "lead",
            "executive"
          ],
          "description": "Target experience level (DEPRECATED scalar  -  prefer `experienceLevels`). When `experienceLevels` is present it wins; this scalar is kept so legacy mobile binaries keep working."
        },
        "experienceLevels": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "entry",
              "mid",
              "senior",
              "lead",
              "executive"
            ],
            "description": "Professional experience level"
          },
          "description": "Target experience levels (multi-select, new source of truth). Empty/omitted = no seniority constraint. The first element is mirrored into the deprecated scalar `experienceLevel`."
        },
        "includeRemote": {
          "type": "boolean",
          "description": "Include region-restricted remote jobs (workStyles \"remote\") even when specific locations are set. Does NOT control worldwide remote  -  see `remoteGlobal`."
        },
        "remoteGlobal": {
          "type": "boolean",
          "description": "Accept worldwide \"Remote  -  Anywhere (Global)\" jobs from any region. Independent of `includeRemote`/workStyles \"remote\" (which stay region-restricted). Set via the \"Remote  -  Anywhere (Global)\" option in the location picker."
        },
        "industries": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Target industries"
        },
        "isActive": {
          "type": "boolean",
          "description": "Enable or disable daily matches"
        },
        "jobTypes": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Preferred job types"
        },
        "locations": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "maxItems": 5,
          "description": "Preferred locations as \"City, Country\" or \"Country\" (max 5). Middle admin segments (state/province) are stripped on ingest. Placeholder values (\"anywhere\", \"any\", ...) are rejected for security (they disable location scoping and let clients harvest the full job pool). An empty array is accepted ONLY for a caller opted into `remoteGlobal` - worldwide remote is itself the location answer."
        },
        "salaryCurrency": {
          "type": "string",
          "enum": [
            "usd",
            "eur",
            "gbp",
            "cad",
            "aud",
            "inr"
          ],
          "description": "Currency for the salary band (converted to USD for matching). Defaults to usd."
        },
        "salaryMax": {
          "type": "number",
          "minimum": 0,
          "description": "Maximum salary requirement"
        },
        "salaryMin": {
          "type": "number",
          "minimum": 0,
          "description": "Minimum salary requirement"
        },
        "skills": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "User skills (from resume or manual entry)"
        },
        "targetRoles": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "minItems": 1,
          "maxItems": 5,
          "description": "Target role titles (max 5). When present, at least one specific title is required  -  empty arrays and placeholder values (\"anywhere\", \"any\", ...) are rejected for security (they disable role scoping and let clients harvest the full job pool)."
        },
        "visaSponsorship": {
          "type": "string",
          "description": "Visa sponsorship preference"
        },
        "workStyles": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "onsite",
              "hybrid",
              "remote"
            ],
            "description": "User's preferred work style, physical mode only, no geo scoping"
          },
          "minItems": 1,
          "description": "Preferred work styles (onsite/hybrid/remote)  -  multi-select, at least 1 required. Geo scoping is inferred from `locations`, NOT this field."
        }
      },
      "additionalProperties": false,
      "description": "Partial job_match_preference patch. Only provided fields are updated. Free-text role + location arrays are canonicalized server-side."
    },
    "aiPersona": {
      "type": "object",
      "properties": {
        "allowFabrication": {
          "type": "boolean",
          "description": "Allow the apply agent to fill gaps: complete a required field it cannot take from profile facts, sourcing real-data-first (the resume, tailored resume, and cover letter for this application, then job preferences, then profile) and fabricating only as a last resort. Enabled by default; set false to opt out. Contact/identity completion is always-on and not gated by this flag."
        },
        "coverLetterStrategy": {
          "type": "string",
          "enum": [
            "off",
            "use_base",
            "tailor_base",
            "generate_new"
          ],
          "description": "Cover letter handling strategy"
        },
        "dailyLimit": {
          "type": "integer",
          "minimum": 1,
          "maximum": 50
        },
        "generateCoverLetterPerJob": {
          "type": "boolean",
          "description": "Whether to generate cover letter per job"
        },
        "minMatchScore": {
          "type": "integer",
          "minimum": 0,
          "maximum": 100
        },
        "mode": {
          "type": "string",
          "enum": [
            "copilot",
            "auto_approve"
          ],
          "description": "Application mode"
        },
        "personalDescription": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 500,
          "description": "Free text about yourself (max 500 chars)"
        },
        "presetId": {
          "type": "string",
          "enum": [
            "balanced",
            "the_professional",
            "the_conversationalist",
            "the_storyteller",
            "the_closer",
            "the_enthusiast",
            "custom"
          ],
          "description": "Selected persona preset"
        },
        "resumeStrategy": {
          "type": "string",
          "enum": [
            "base",
            "tailor"
          ],
          "description": "Resume handling strategy"
        },
        "samplePhrases": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string",
            "maxLength": 200
          },
          "maxItems": 10,
          "description": "Example phrases you naturally use (max 10)"
        },
        "tailorResumePerJob": {
          "type": "boolean",
          "description": "Whether to tailor resume per job"
        },
        "toneInstructions": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 1000,
          "description": "Custom tone rules (max 1000 chars)"
        },
        "translationStrategy": {
          "type": "string",
          "enum": [
            "off",
            "translate",
            "translate_and_tailor"
          ],
          "description": "Translation strategy"
        }
      },
      "additionalProperties": false,
      "description": "Partial ai_persona patch. Strategy enums win over legacy booleans via mirrorLegacyBooleans()."
    }
  },
  "additionalProperties": false
}