Customers

Delete multiple customers

Deactivates (marks as deleted) multiple customers in a single operation. **Soft delete:** Customers are not physically deleted, only marked as inactive. **Partial behavior:** Valid customers will be deactivated, failures are reported in the errors array.

DELETE
/v1/customers/bulk

Authorization

AuthorizationBearer <token>

API Key authentication.

Format: Authorization: Bearer beel_sk_<key>

Scopes: API Keys use the same scopes as OAuth2 tokens. Each key is created with specific scopes that limit which endpoints it can access. The required scope for each endpoint is documented in the operation's security section under OAuth2.

Obtaining Keys: API Keys are managed from the BeeL dashboard

Security: API Keys are secret credentials. Do not share them or store them in source code

In: header

Query Parameters

idsstring

Comma-separated customer IDs

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://app.beel.es/api/v1/customers/bulk?ids=550e8400-e29b-41d4-a716-446655440000%2C550e8400-e29b-41d4-a716-446655440001"
{
  "success": true,
  "data": {
    "total": 10,
    "successful": 8,
    "failed": 2,
    "deactivated_ids": [
      "550e8400-e29b-41d4-a716-446655440000"
    ],
    "errors": [
      {
        "customer_id": "550e8400-e29b-41d4-a716-446655440000",
        "error": {
          "code": "CLIENT_HAS_INVOICES",
          "message": "Cannot deactivate customer because it has associated invoices"
        }
      }
    ]
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}
{
  "success": false,
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}
{
  "success": false,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}

Deactivate customer DELETE

Deactivates (marks as deleted) a customer. **Soft delete:** The customer is not physically deleted, only marked as inactive. **Restriction:** Cannot deactivate a customer with associated invoices.

Download CSV template for customers POST

Downloads a sample CSV file for customer import. **Format**: The file includes the required headers and example rows with UTF-8 BOM for Excel compatibility.