---
title: "Partially update a user"
method: PATCH
path: "/scim/v2/Users/{id}"
tags: ["SCIM"]
---

# Partially update a user

`PATCH /scim/v2/Users/{id}`

Updates an existing user resource, overwriting values for specified attributes.
The value of the {id} should be the user's corresponding user ID. Attributes that are not provided in the request will remain unchanged. Updating a value to " " will clear and remove the field from the user's profile.

## Path parameters

- `id` string, required

## Headers

- `Idempotency-Key` string
- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string

## Request body

- object
  - `schemas` string[], required
  - `Operations` object[], required
    - `op` 'replace' | 'add' | 'remove' | 'copy' | 'move' | 'test'
    - `path` string
    - `value` object
      - `emails` object[]
        - `value` string, email
        - `display` string
        - `type` 'work' | 'home' | 'other'
        - `primary` boolean

## Response `200`

OK

- object
  - `schemas` string[] — A list of schema URNs that are applicable to the user resource. This helps to identify the structure and format of the returned data.
  - `id` string — The unique identifier for the user resource.
  - `meta` object
    - `created` string, date-time — The timestamp when the user resource was created, in ISO 8601 format.
    - `resourceType` string — The type of the resource, in this case, it is always 'User' for user resources.
    - `location` string — The URL where the full representation of the user resource can be retrieved.
  - `userName` string — The username for the user. This is a unique identifier for the user in the system.
  - `name` object
    - `formatted` string — The full name of the user formatted as a single string (e.g., 'John Doe').
    - `familyName` string — The family name (or surname) of the user.
    - `givenName` string — The given name (or first name) of the user.
  - `displayName` string — The display name of the user, which may be used in UIs.
  - `preferredLanguage` string — The preferred language of the user for communication.
  - `locale` string — The locale of the user, typically a language code combined with a region (e.g., 'en-US').
  - `active` boolean — Indicates whether the user account is active or not.
  - `emails` object[]
    - `value` string — The email address of the user.
    - `display` string — A display name for the email address, typically the same as the email value.
    - `type` string — The type of the email address (e.g., 'work', 'home').
    - `primary` boolean — Indicates whether this email address is the primary address for the user.
  - `groups` object[]
    - `value` string — The unique identifier for the group the user belongs to.
    - `display` string — The display name of the group.
  - `roles` object[]
    - `value` string — The role assigned to the user.
    - `display` string — A display name for the role.
  - `urn:zuora:scim:schemas:1.0:UserExtension` object
    - `schemas` string[] — A list of schema URNs that are specific to Zuora's extended user schema.
    - `organizationId` string — The unique identifier for the organization to which the user belongs.
    - `status` string — The current status of the user (e.g., ACTIVE, INACTIVE).
    - `ssoEnabled` boolean — Indicates whether Single Sign-On (SSO) is enabled for this user.
    - `region` string

## Other responses

- `204` — No Content
- `401` — Unauthorized - The request lacks valid authentication credentials.
- `403` — Forbidden - The server understands the request but refuses to authorize it.

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)