# Bulk update users

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

Endpoint: PATCH /scim/v2/Users/bulk
Version: 2026-02-20
Security: bearerAuth

## Request fields (application/json):

  - `schemas` (array)
    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)

  - `meta.created` (string)
    The date and time when the resource was created, in ISO 8601 format.

  - `meta.resourceType` (string)
    The type of resource (e.g., User) this metadata pertains to.

  - `meta.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)

  - `name.formatted` (string)
    The full name of the user in a formatted string (e.g., 'John Doe').

  - `name.familyName` (string)
    The family name (or surname) of the user.

  - `name.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` (array)

  - `emails.value` (string)
    The email address of the user.

  - `emails.display` (string)
    A display name for the email address, often the same as the email address itself.

  - `emails.type` (string)
    The type of email address (e.g., 'work', 'home').

  - `emails.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` (array)

  - `roles.value` (string)
    The role assigned to the user (e.g., 'ADMIN', 'USER').

  - `roles.display` (string,null)

  - `urn:zuora:scim:schemas:1.0:UserExtension` (object)

  - `urn:zuora:scim:schemas:1.0:UserExtension.schemas` (array)
    A list of schema URNs specific to the user extension, indicating additional attributes.

  - `urn:zuora:scim:schemas:1.0:UserExtension.organizationId` (string)
    An identifier for the organization associated with the user, often used for organizational contexts.

  - `urn:zuora:scim:schemas:1.0:UserExtension.status` (string)
    The current status of the user within the system (e.g., 'ACTIVE', 'PENDING').

  - `urn:zuora:scim:schemas:1.0:UserExtension.ssoEnabled` (boolean)
    Indicates whether Single Sign-On (SSO) is enabled for the user. A value of true means SSO is enabled.

  - `urn:zuora:scim:schemas:1.0:UserExtension.region` (string)

## Response 200 fields (application/json):

  - `itemsPerPage` (integer)
    The items that are allowed on each page.

  - `startIndex` (integer)

  - `schemas` (array)
    A list of schema URNs that apply to this resource, indicating the structure and attributes of the response.

  - `id` (string,null)
    A unique identifier for the response resource, typically the ID of the user or group.

  - `externalId` (string,null)
    An external identifier for the resource, often used for integration with external systems.

  - `meta` (object,null)

  - `meta.created` (string)
    The date and time when the user resource was created, in ISO 8601 format.

  - `meta.resourceType` (string)
    The type of resource (e.g., 'User').

  - `meta.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` (array)

  - `resources.schemas` (array)
    A list of schema URNs that define the structure and attributes of the user resource.

  - `resources.id` (string,null)
    A unique identifier for the user resource.

  - `resources.userName` (string)
    The username of the user, typically used as a unique identifier.

  - `resources.name` (object)

  - `resources.name.formatted` (string)
    The full name of the user formatted as a single string (e.g., 'John Doe').

  - `resources.name.familyName` (string)
    The user's family name (surname).

  - `resources.name.givenName` (string)
    The user's given name (first name).

  - `resources.displayName` (string)
    A display name for the user, which may differ from the username or full name.

  - `resources.preferredLanguage` (string)
    The user's preferred language for communication and content.

  - `resources.locale` (string)
    The user's locale, which typically indicates regional settings (e.g., 'en-US').

  - `resources.active` (boolean)
    Indicates whether the user account is currently active. true means active, false means inactive.

  - `resources.emails` (array)

  - `resources.emails.value` (string)
    The email address of the user.

  - `resources.emails.display` (string)
    A display name for the email address, often the same as the email address itself.

  - `resources.emails.type` (string)
    The type of email address (e.g., 'work', 'home').

  - `resources.emails.primary` (boolean)
    Indicates whether this email address is the primary one for the user. true means primary.

  - `resources.roles` (array)

  - `resources.roles.value` (string)
    The role assigned to the user (e.g., 'ADMIN').

  - `resources.roles.display` (string,null)

  - `resources.urn:zuora:scim:schemas:1.0:UserExtension` (object)

  - `resources.urn:zuora:scim:schemas:1.0:UserExtension.schemas` (array)
    A list of schema URNs specific to the user extension, detailing additional attributes.

  - `resources.urn:zuora:scim:schemas:1.0:UserExtension.organizationId` (string)
    An identifier for the organization associated with the user.
    Example: "ec141dc2-901e-4813-a25d-ef480cff1e26"

  - `resources.urn:zuora:scim:schemas:1.0:UserExtension.status` (string)
    The current status of the user (e.g., 'ACTIVE', 'NEW').
    Example: "NEW"

  - `resources.urn:zuora:scim:schemas:1.0:UserExtension.ssoEnabled` (boolean)
    Indicates whether Single Sign-On (SSO) is enabled for the user. true means SSO is enabled.

  - `resources.urn:zuora:scim:schemas:1.0:UserExtension.region` (string)

## Response 401 fields (application/json):

  - `success` (boolean)
    Indicates whether the request was successful. For unauthorized requests, this will be false.

  - `reasons` (array)

  - `reasons.message` (string)
    A description of why the request is unauthorized (e.g., 'Invalid credentials').

  - `reasons.code` (string)
    A code representing the specific reason for the unauthorized access (e.g., '90000011').

## Response 403 fields (application/json):

  - `timestamp` (string)
    The timestamp when the error occurred, in ISO 8601 format.

  - `status` (integer)
    The HTTP status code for the error, which will be 403 for Forbidden.

  - `error` (string)
    A short description of the error (e.g., 'Forbidden').

  - `message` (string)
    A detailed message explaining why access was denied (e.g., 'Admin access denied').

  - `path` (string)
    The API endpoint path where the error occurred (e.g., '/scim/v2/Users').