Skip to content

Customer Bulk ​

Bulk customer create/update operations

INFO

Every response arrives in the shared envelope — code, message, messages, status_code, time — with the payload in data. The tables below describe what is inside data.

POST /customer/delete-many ​

Soft-delete multiple customers in a single call (sets is_deleted=true on each). Pass either an explicit list of ObjectIds in ids, or set is_all=true with optional filters to delete all matched customers. Returns the count of deleted documents.

Request body

FieldTypeRequiredDescription
idsstring[]NoExplicit list of customer ObjectIds to soft-delete. Mutually exclusive with is_all=true.
is_allbooleanNoWhen true, soft-delete all customers matched by the optional filters. Must not be combined with ids.
searchstringNoOptional text search filter applied when is_all=true. Matches against customer name, phone, and similar indexed fields.
json
{
  "ids": [
    "string"
  ],
  "is_all": false,
  "search": "string"
}

Response

FieldTypeDescription
deleted_countnumberNumber of customer documents that were soft-deleted
json
{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "deleted_count": 0
  },
  "time": "2025-05-01T12:00:00Z"
}

This page is generated from the OpenAPI spec.

Bito 2.0 Integration API