onboarding

Upsert Onboarding Profile

Soft-patch the user's onboarding wizard answers. Every field is optional; only the fields posted are written. Idempotent per screen.

post/onboarding/profile

Request

  • Base URL: https://api.aiapplyd.com/api/v1
  • URL: https://api.aiapplyd.com/api/v1/onboarding/profile
  • Auth: HTTP bearer

Request body

activelyLookingboolean
triedOtherAppsboolean
importancestring[]
categoriesstring[]
rolesstring[]
customRolesstring[]
experienceBand'internship' | 'entry' | 'junior' | 'mid' | 'senior' | 'expert'

Onboarding-facing experience band picked by the user

experienceBandsstring[]
locationsstring[]
remoteGlobalboolean
countrystring
salaryMinnumber
salaryMaxnumber
salaryCurrency'usd' | 'eur' | 'gbp' | 'cad' | 'aud' | 'inr'

Currency for salary values

goal'land_asap' | 'make_more_money' | 'land_dream_job'

The user's primary job-search goal

interviewsPerWeekTargetinteger
jobTimeline'one_month' | 'three_months' | 'six_months' | 'twelve_months_plus'

How soon the user wants to land a new role

blockersstring[]
motivationsstring[]
attributionSource'social' | 'influencer' | 'friend' | 'search' | 'ad' | 'other'

How the user discovered AI Applyd

referralCodeUsedstring
resumeDeferredboolean
fullLegalNamestring
phonestring
completedStepsstring[]

Example request

{
  "importance": [
    "meaningful_work"
  ],
  "categories": [
    "software_engineering"
  ],
  "experienceBand": "mid",
  "experienceBands": [
    "mid"
  ],
  "salaryCurrency": "usd",
  "goal": "land_asap",
  "jobTimeline": "three_months",
  "blockers": [
    "not_applying_enough"
  ],
  "motivations": [
    "more_money"
  ],
  "attributionSource": "search",
  "completedSteps": [
    "upload-resume"
  ]
}

Response

Persisted onboarding profile

successtrue required

Example response

{
  "data": {
    "importance": [
      "meaningful_work"
    ],
    "categories": [
      "software_engineering"
    ],
    "experienceBand": "mid",
    "experienceBands": [
      "mid"
    ],
    "goal": "land_asap",
    "jobTimeline": "three_months",
    "blockers": [
      "not_applying_enough"
    ],
    "motivations": [
      "more_money"
    ],
    "attributionSource": "search",
    "completedSteps": [
      "upload-resume"
    ]
  },
  "meta": {
    "duration": 150,
    "requestId": "req_abc123",
    "timestamp": "2026-10-13T10:27:20.268Z",
    "version": "v1"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.