---
updatedAt: 2025-10-02T22:25:04.000Z
agentTools:
  projectIndex: https://developer.bill.com/v2/llms.txt
---

# Bulk delete users

Bulk delete user objects. The maximum number of objects you can set in a bulk operation is 100.

In the response, `isActive` is set as `2` (Inactive).

**Note**: You can only assign active users to approve bills or vendor credits. Before deleting an Approver user, make sure that you set another user as an Approver for the bill or vendor credit.

### What is a user?
A BILL organization user can perform operations depending on their user role profile (Administrator, Accountant, Approver, Clerk, Payer, Custom).

You can create a new user object with `/v2/Crud/Create/User.json`. The user role `profileId` is required for creating and managing users. Retrieve `id` values for all user role profiles with `/v2/List/Profile.json`.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Organization | Basic operations",
    "version": "2.0",
    "description": "BILL is a cloud-based cash flow management system for an organization's Accounts Payable (AP) and Accounts Receivable (AR) automation.\n * **AP**: Automate workflows to pay vendors bills at scale for the goods and services they provide. Pay vendors with a wide range of payment methods. Generate vendor credits, bill credits, and payment disbursement reports.\n * **AR**: Automate workflows to get paid by customers at scale for the goods and services you provide. Generate and send invoices on a schedule, generate customer and invoice credits, and seamlessly charge authorized customers.\n * **Organization**: Manage your bank accounts (for sending and receiving payments), users (with user roles), and sync with your choice of accounting software.\n\nIntegrate with the BILL API to send and receive payments for your business. See [Support Center](https://help.bill.com/hc/en-us) for resources about using the BILL web app.",
    "contact": {
      "email": "developerprogram@hq.bill.com"
    }
  },
  "servers": [
    {
      "url": "https://api-stage.bill.com/api/v2",
      "description": "Sandbox base URL"
    }
  ],
  "x-readme": {
    "samples-languages": [
      "curl",
      "java",
      "javascript",
      "python",
      "ruby"
    ],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "paths": {
    "/Bulk/Crud/Delete/User.json": {
      "post": {
        "summary": "Bulk delete users",
        "operationId": "org-basic-bulkdeleteuser",
        "description": "Bulk delete user objects. The maximum number of objects you can set in a bulk operation is 100.\n\nIn the response, `isActive` is set as `2` (Inactive).\n\n**Note**: You can only assign active users to approve bills or vendor credits. Before deleting an Approver user, make sure that you set another user as an Approver for the bill or vendor credit.\n\n### What is a user?\nA BILL organization user can perform operations depending on their user role profile (Administrator, Accountant, Approver, Clerk, Payer, Custom).\n\nYou can create a new user object with `/v2/Crud/Create/User.json`. The user role `profileId` is required for creating and managing users. Retrieve `id` values for all user role profiles with `/v2/List/Profile.json`.",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BulkDeleteUserResponse"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "required": [
                  "devKey",
                  "sessionId",
                  "data"
                ],
                "properties": {
                  "devKey": {
                    "type": "string",
                    "description": "Developer key generated with your BILL developer account"
                  },
                  "sessionId": {
                    "type": "string",
                    "description": "API session ID generated with [`/v2/Login.json`](ref:auth-login)"
                  },
                  "data": {
                    "$ref": "#/components/schemas/BulkDeleteUserRequest"
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Users"
        ]
      },
      "parameters": []
    }
  },
  "components": {
    "schemas": {
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "error_code": {
            "type": "string",
            "description": "Error code (only when `response_status` is `1`)"
          },
          "error_message": {
            "type": "string",
            "description": "Error message (only when `response_status` is `1`)"
          }
        }
      },
      "CreateUserResponse": {
        "type": "object",
        "properties": {
          "response_status": {
            "type": "integer",
            "description": "Response status.\n* `0`: Success response\n* `1`: Error response. Only `error_code` and `error_message` is returned in `response_data`."
          },
          "response_message": {
            "type": "string",
            "description": "Response status.\n* `Success`: Success response\n* `Error`: Error response. Only `error_code` and `error_message` is returned in `response_data`."
          },
          "response_data": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ErrorResponse"
              }
            ],
            "properties": {
              "entity": {
                "type": "string",
                "description": "Object type. Set as `User`."
              },
              "id": {
                "type": "string",
                "description": "BILL-generated ID of the user. The value begins with `006`."
              },
              "isActive": {
                "type": "string",
                "description": "Object visibility status. Inactive objects are hidden by default in the BILL web app.\n* `1`: Active\n* `2`: Inactive"
              },
              "createdTime": {
                "type": "string",
                "description": "Created date and time"
              },
              "updatedTime": {
                "type": "string",
                "description": "Updated date and time"
              },
              "loginId": {
                "type": "string",
                "description": "BILL-generated login ID for the user. The value begins with `005`."
              },
              "profileId": {
                "type": "string",
                "description": "BILL-generated ID of of the user role profile. This value begins with `0po`."
              },
              "firstName": {
                "type": "string",
                "description": "User first name"
              },
              "lastName": {
                "type": "string",
                "description": "User last name"
              },
              "email": {
                "type": "string",
                "description": "User email address"
              },
              "timezoneId": {
                "type": "string",
                "description": "User time zone.\n* `1`: Hawaii–Aleutian Standard Time (HST)\n* `2`: Alaska Standard Time (AST)\n* `3`: Pacific Standard Time (PST)\n* `4`: Mountain Standard Time (MST)\n* `5`: Central Standard Time (CST)\n* `6`: Eastern Standard Time (EST)\n* `7`: Puerto Rico and US Virgin Islands Time (PRT)\n* `8`: Argentina Standard Time (AGT)\n* `9`: Greenwich Mean Time (GMT)\n* `10`: European Central Time (ECT)\n* `11`: Egypt Standard Time (ART)\n* `12`: Eastern African Time (EAT)\n* `13`: India Standard Time (IST)\n* `14`: Bangladesh Standard Time (BST)\n* `15`: Vietnam Standard Time (VST) \n* `16`: China Standard Time (PRC)\n* `17`: Japan Standard Time (JST)\n* `18`: Australia Eastern Time (AET)\n* `19`: Solomon Standard Time (SST)\n* `21`: New Zealand Standard Time (NST)\n* `22`: MST7MDT\n* `23`: EST5EDT"
              },
              "partnerUserGroupType": {
                "type": "string",
                "description": "This field is available only for select BILL partners"
              }
            }
          }
        }
      },
      "DeleteUserRequest": {
        "type": "object",
        "required": [
          "id"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "BILL-generated ID of the user. The value begins with `006`."
          }
        }
      },
      "BulkDeleteUserRequest": {
        "type": "object",
        "required": [
          "bulk"
        ],
        "properties": {
          "bulk": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DeleteUserRequest"
            }
          }
        }
      },
      "BulkDeleteUserResponse": {
        "type": "object",
        "properties": {
          "response_status": {
            "type": "integer",
            "description": "Response status.\n* `0`: Success response\n* `1`: Error response. Only `error_code` and `error_message` is returned in `response_data`."
          },
          "response_message": {
            "type": "string",
            "description": "Response status.\n* `Success`: Success response\n* `Error`: Error response. Only `error_code` and `error_message` is returned in `response_data`."
          },
          "response_data": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/ErrorResponse"
              }
            ],
            "properties": {
              "bulk": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/CreateUserResponse"
                }
              }
            }
          }
        }
      }
    }
  }
}
```