---
title: "Bulk update users"
method: PATCH
path: "/scim/v2/Users/bulk"
tags: ["SCIM"]
---

# Bulk update users

`PATCH /scim/v2/Users/bulk`

Updates an existing multiple user resource, overwriting values for specified attributes.

## Request body

- object[]
  - `schemas` string[] — A list of schema URNs that apply to this resource, indicating the structure and attributes of the resource.
  - `id` string — A unique identifier for the resource within the system.
  - `externalId` string — An external identifier for the resource, often used for integration with external systems.
  - `meta` object
    - `created` string, date-time — The date and time when the resource was created, in ISO 8601 format.
    - `resourceType` string — The type of resource (e.g., User) this metadata pertains to.
    - `location` string — The URL where the resource can be accessed or retrieved.
  - `userName` string — The username of the user. This is typically a unique identifier for the user within the system.
  - `name` object
    - `formatted` string — The full name of the user in a formatted 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 — A name that is suitable for display to end-users, which may be different from the username or full name.
  - `preferredLanguage` string — The preferred language of the user for communication and content.
  - `locale` string — The locale of the user, typically used to determine regional settings (e.g., 'en-US' for English, United States).
  - `active` boolean — Indicates whether the user account is currently active. A value of `true` means the account is active, and `false` means it is inactive.
  - `emails` object[]
    - `value` string — The email address of the user.
    - `display` string — A display name for the email address, often the same as the email address itself.
    - `type` string — The type of email address (e.g., 'work', 'home').
    - `primary` boolean — Indicates whether this email address is the primary one for the user. A value of `true` means it is the primary email.
  - `roles` object[]
    - `value` string — The role assigned to the user (e.g., 'ADMIN', 'USER').
    - `display` string, nullable
  - `urn:zuora:scim:schemas:1.0:UserExtension` object
    - `schemas` string[] — A list of schema URNs specific to the user extension, indicating additional attributes.
    - `organizationId` string — An identifier for the organization associated with the user, often used for organizational contexts.
    - `status` string — The current status of the user within the system (e.g., 'ACTIVE', 'PENDING').
    - `ssoEnabled` boolean — Indicates whether Single Sign-On (SSO) is enabled for the user. A value of `true` means SSO is enabled.
    - `region` string

## Response `200`

OK

- object
  - `itemsPerPage` integer — The items that are allowed on each page.
  - `startIndex` integer
  - `schemas` string[] — A list of schema URNs that apply to this resource, indicating the structure and attributes of the response.
  - `id` string, nullable — A unique identifier for the response resource, typically the ID of the user or group.
  - `externalId` string, nullable — An external identifier for the resource, often used for integration with external systems.
  - `meta` object, nullable
    - `created` string, date-time — The date and time when the user resource was created, in ISO 8601 format.
    - `resourceType` string — The type of resource (e.g., 'User').
    - `location` string — The URL where the user resource can be accessed or retrieved.
  - `totalResults` integer — The total number of results returned by the request. This helps in pagination and determining the total size of the dataset.
  - `resources` object[]
    - `schemas` string[] — A list of schema URNs that define the structure and attributes of the user resource.
    - `id` string, nullable — A unique identifier for the user resource.
    - `externalId` string, nullable — An external identifier for the resource, often used for integration with external systems.
    - `meta` object
      - `created` string, date-time — The date and time when the user resource was created, in ISO 8601 format.
      - `resourceType` string — The type of resource (e.g., 'User').
      - `location` string — The URL where the user resource can be accessed or retrieved.
    - `userName` string — The username of the user, typically used as a unique identifier.
    - `name` object
      - `formatted` string — The full name of the user formatted as a single string (e.g., 'John Doe').
      - `familyName` string — The user's family name (surname).
      - `givenName` string — The user's given name (first name).
    - `displayName` string — A display name for the user, which may differ from the username or full name.
    - `preferredLanguage` string — The user's preferred language for communication and content.
    - `locale` string — The user's locale, which typically indicates regional settings (e.g., 'en-US').
    - `active` boolean — Indicates whether the user account is currently active. `true` means active, `false` means inactive.
    - `emails` object[]
      - `value` string — The email address of the user.
      - `display` string — A display name for the email address, often the same as the email address itself.
      - `type` string — The type of email address (e.g., 'work', 'home').
      - `primary` boolean — Indicates whether this email address is the primary one for the user. `true` means primary.
    - `roles` object[]
      - `value` string — The role assigned to the user (e.g., 'ADMIN').
      - `display` string, nullable
    - `urn:zuora:scim:schemas:1.0:UserExtension` object
      - `schemas` string[] — A list of schema URNs specific to the user extension, detailing additional attributes.
      - `organizationId` string, uuid — An identifier for the organization associated with the user.
      - `status` string — The current status of the user (e.g., 'ACTIVE', 'NEW').
      - `ssoEnabled` boolean — Indicates whether Single Sign-On (SSO) is enabled for the user. `true` means SSO is enabled.
      - `region` string

## Other responses

- `204` — No Content
- `401` — Unauthorized
- `403` — Forbidden

---

[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)