---
title: "Update Onboarding Profile"
method: PATCH
path: "/api/users/me/onboarding-profile"
tags: ["Onboarding profile"]
---

# Update Onboarding Profile

`PATCH /api/users/me/onboarding-profile`

## Request

- Base URL: `https://api.earmarkiq.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.earmarkiq.app/api/users/me/onboarding-profile`
- Auth: HTTP bearer

## Request body

- OnboardingProfile: All seven answers. Every field optional: someone who signs in from "Already have an account?" and registers later has none, and Settings edits one field at a time. Unknown keys are rejected, not stored.
  - `primary_goal` 'keep_more' | 'save_up' | 'debt_behind' | 'payday', nullable
  - `pay_rhythm` 'monthly' | 'four_weekly' | 'weekly' | 'changes', nullable
  - `money_feeling` 'feeling_good' | 'getting_there' | 'hand' | 'a_lot', nullable
  - `household` 'just_me' | 'partner' | 'bit_of_both', nullable
  - `focus_area` 'subscriptions' | 'eating_out' | 'shopping' | 'before_payday' | 'bills', nullable
  - `prior_habit` 'bank_app' | 'spreadsheet' | 'another_app' | 'in_my_head', nullable
  - `contact_preference` 'needs_a_look' | 'weekly_summary' | 'app_only', nullable

## Response `200`

Successful Response

- OnboardingProfileResponse
  - `profile` OnboardingProfile, required: All seven answers. Every field optional: someone who signs in from "Already have an account?" and registers later has none, and Settings edits one field at a time. Unknown keys are rejected, not stored.
    - `primary_goal` 'keep_more' | 'save_up' | 'debt_behind' | 'payday', nullable
    - `pay_rhythm` 'monthly' | 'four_weekly' | 'weekly' | 'changes', nullable
    - `money_feeling` 'feeling_good' | 'getting_there' | 'hand' | 'a_lot', nullable
    - `household` 'just_me' | 'partner' | 'bit_of_both', nullable
    - `focus_area` 'subscriptions' | 'eating_out' | 'shopping' | 'before_payday' | 'bills', nullable
    - `prior_habit` 'bank_app' | 'spreadsheet' | 'another_app' | 'in_my_head', nullable
    - `contact_preference` 'needs_a_look' | 'weekly_summary' | 'app_only', nullable
  - `updated_at` string, date-time, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/earmarkiq/apis/earmark-api.md) · [All operations](https://skmtc.dev/earmarkiq/apis/earmark-api/llms.txt) · [OpenAPI document](https://skmtc.dev/earmarkiq/apis/earmark-api/revisions/4a2c41907105?raw)