# Delete a list of users

Sets multiple users to deactivate.
The value of the id should be the user's corresponding user ID.

Endpoint: POST /scim/v2/Users/delete
Version: 2026-02-20
Security: bearerAuth

## Header parameters:

  - `Idempotency-Key` (string)
    Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. 

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

  - `Accept-Encoding` (string)
    Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. 

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

  - `Content-Encoding` (string)
    Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

  - `Zuora-Track-Id` (string)
    A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

  - `Zuora-Entity-Ids` (string)
    An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

## Response 200 fields (application/json):

  - `resources` (array)

  - `resources.schemas` (array)

  - `resources.externalId` (string,null)
    An external identifier associated with the resource, if available.

  - `resources.id` (string,null)
    The unique identifier assigned to the resource.

  - `resources.meta` (object,null)

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

  - `resources.meta.location` (string)
    The URL where the resource can be accessed.

  - `resources.meta.created` (string)
    The creation date and time when the resource was created.

  - `resources.schemaUrns` (array)
    A list of URNs for SCIM schemas that this resource conforms to.

  - `externalId` (string,null)
    An external identifier associated with the collection of resources, if available.

  - `id` (string,null)
    The unique identifier for the collection of resources.

  - `itemsPerPage` (integer)
    The number of items returned per page in the response.

  - `schemas` (array)
    A list of URNs for SCIM schemas applicable to the collection of resources.

  - `startIndex` (integer)
    The index of the first item in the current page of results.

  - `totalResults` (integer)
    The total number of results available across all pages.

## Response 201 fields (application/json):

  - `schemas` (array)
    A list of URNs for SCIM schemas that this resource conforms to.

  - `id` (string)
    The unique identifier for the resource.

  - `meta` (object)

  - `meta.created` (string)
    The date and time when the resource was created.

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

  - `meta.location` (string)
    The URL where the resource can be accessed.

  - `userName` (string)
    The username of the user.

  - `name` (object)

  - `name.formatted` (string)
    The full name of the user, formatted for display.

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

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

  - `displayName` (string)
    The display name of the user.

  - `preferredLanguage` (string)
    The preferred language of the user.

  - `locale` (string)
    The locale of the user, typically in the format 'language-COUNTRY' (e.g., 'en-US').

  - `active` (boolean)
    Indicates whether the user is active.

  - `emails` (array)
    A list of email addresses associated with the user.

  - `emails.value` (string)
    The email address.

  - `emails.display` (string)
    A human-readable form of the email address.

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

  - `emails.primary` (boolean)
    Indicates whether this is the primary email address.

  - `groups` (array)
    A list of groups the user is a member of.

  - `groups.value` (string)
    The unique identifier for the group.

  - `groups.display` (string)
    The display name of the group.

  - `roles` (array)
    A list of roles assigned to the user.

  - `roles.value` (string)
    The role assigned to the user.

  - `roles.display` (string)
    The display name of the role.

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

  - `urn:zuora:scim:schemas:1.0:UserExtension.schemas` (array)
    A list of URNs for SCIM schemas that this extension conforms to.

  - `urn:zuora:scim:schemas:1.0:UserExtension.organizationId` (string)
    The identifier for the organization to which the user belongs.

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

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

  - `urn:zuora:scim:schemas:1.0:UserExtension.region` (string)
    The region or geographic location associated with the user.

## Response 401 fields (application/json):

  - `success` (boolean)
    Indicates whether the request was successful. A value of false indicates that an error occurred.

  - `reasons` (array)

  - `reasons.message` (string)
    A human-readable message describing the error or reason for the failure.
    Example: "Unauthorized"

  - `reasons.code` (string)
    A specific error code representing the type of error. This code can be used for programmatic error handling.
    Example: "90000011"

## Response 403 fields (application/json):

  - `timestamp` (string)
    The date and time when the error occurred, formatted according to ISO 8601.
    Example: "2023-07-28T10:47:07.931+00:00"

  - `status` (integer)
    The HTTP status code associated with the error response. Indicates the type of error that occurred.
    Example: 403

  - `error` (string)
    A short, descriptive name for the error. Often corresponds to the HTTP status code.
    Example: "Forbidden"

  - `message` (string)
    A detailed message describing the error that occurred. This message is intended to help the client understand the nature of the problem.
    Example: "Admin access denied"

  - `path` (string)
    The URI path of the request that resulted in the error. This can help identify which resource or endpoint caused the issue.
    Example: "/scim/v2/Users/delete"

## Response 404 fields (application/json):

  - `schemas` (array)
    A list of URNs indicating the schemas that describe the structure of the error response. This provides information on the format and content of the error message.
    Enum: "urn:ietf:params:scim:api:messages:2.0:Error"

  - `status` (string)
    A string representation of the HTTP status code indicating the error. This helps in identifying the type of error that occurred.

  - `detail` (string)
    A detailed message providing additional context or explanation about the error. This helps in understanding the specific issue or reason for the error.