Skip to content
Micro micro
Go to Micro
API Reference
Prism
Objects
Contacts

Bulk delete records (partial success)

prism.objects.contacts.bulk_delete(ContactBulkDeleteParams**kwargs) -> ContactBulkDeleteResponse
POST/v2/prism/{teamId}/contact/batch/delete

Soft-delete up to 100 records in a single call. Same partial-success contract as batch/update.

ParametersExpand Collapse
team_id: Optional[str]
formatuuid
ids: Sequence[str]
idempotency_key: Optional[str]
minLength1
maxLength255
ReturnsExpand Collapse
class ContactBulkDeleteResponse: …

Partial-success bulk operation result. Inspect results[].status per item; the operation as a whole returns 200 even if some items failed.

results: List[Result]
id: Optional[str]

Item ID, or null if the input was unparseable.

status: Literal["ok", "error"]
One of the following:
"ok"
"error"
error: Optional[ResultError]
code: Optional[str]
message: Optional[str]
record: Optional[ResultRecord]

Object returned by reads (get/create/patch/restore). id is always present.

id: str
formatuuid
default: Optional[Dict[str, object]]

Properties keyed by property slug.

list: Optional[object]
summary: Summary
failed: int
succeeded: int
total: int

Bulk delete records (partial success)

import os
from micro_so import Micro

client = Micro(
    api_key=os.environ.get("MICRO_API_KEY"),  # This is the default and can be omitted
)
response = client.prism.objects.contacts.bulk_delete(
    ids=["182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"],
)
print(response.results)
{
  "results": [
    {
      "id": "id",
      "status": "ok",
      "error": {
        "code": "code",
        "message": "message"
      },
      "record": {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "default": {
          "foo": "bar"
        },
        "list": {}
      }
    }
  ],
  "summary": {
    "failed": 0,
    "succeeded": 0,
    "total": 0
  }
}
Returns Examples
{
  "results": [
    {
      "id": "id",
      "status": "ok",
      "error": {
        "code": "code",
        "message": "message"
      },
      "record": {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "default": {
          "foo": "bar"
        },
        "list": {}
      }
    }
  ],
  "summary": {
    "failed": 0,
    "succeeded": 0,
    "total": 0
  }
}