---
title: "Patch User"
method: PATCH
path: "/users"
---

# Patch User

`PATCH /users`

## Headers

- `Authorization` string, nullable
- `X-User-Id` string, nullable

## Cookies

- `session_id` string, nullable

## Request body

- PatchUserSchema
  - `ui_config` UIConfig
    - `start_of_week` 0 | 1
    - `timezone` string
    - `currency` string
    - `table_settings` object
    - `overview_custom_dimensions` Selection[]
      - `id` integer, required
      - `values` string[], required
  - `cost_settings` CostSettings
    - `cogs_fallback_rate` number
    - `payment_processing_rate` number
    - `payment_processing_flat_fee` AmountCurrency
      - `amount` number
      - `currency` string, nullable
    - `shipping_use_charges_as_cost` boolean
    - `shipping_flat_fee` AmountCurrency
      - `amount` number
      - `currency` string, nullable
  - `workspace_settings` PatchWorkspaceSettings — User-writable workspace settings. Excludes features (admin-only).
    - `attributed_spend_settings` AttributedSpendSettings
      - `event_name` 'Viewed Product' | 'Added To Cart' | 'Placed Order', required

## Response `200`

Successful Response

- ConvergeApiApiSchemasUserSchema
  - `id` integer, required
  - `name` string, nullable
  - `email` string, nullable
  - `urn` string, nullable
  - `onboarding_complete` boolean, required
  - `properties` object, required
  - `token` object, required
  - `ui_config` UIConfig
    - `start_of_week` 0 | 1
    - `timezone` string
    - `currency` string
    - `table_settings` object
    - `overview_custom_dimensions` Selection[]
      - `id` integer, required
      - `values` string[], required
  - `app_logo` string, nullable
  - `cost_settings` CostSettings
    - `cogs_fallback_rate` number
    - `payment_processing_rate` number
    - `payment_processing_flat_fee` AmountCurrency
      - `amount` number
      - `currency` string, nullable
    - `shipping_use_charges_as_cost` boolean
    - `shipping_flat_fee` AmountCurrency
      - `amount` number
      - `currency` string, nullable
  - `workspace_settings` WorkspaceInternalSettings
    - `features` object
    - `attributed_spend_settings` AttributedSpendSettings
      - `event_name` 'Viewed Product' | 'Added To Cart' | 'Placed Order', required
  - `organization` OrganizationSchema
    - `id` integer, required
    - `name` string, required
    - `hubspot_company_id` string, nullable
  - `active` boolean, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/runconverge/apis/fastapi.md) · [All operations](https://skmtc.dev/runconverge/apis/fastapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/runconverge/fastapi/revisions/1452e350bd1d/schema)