Skip to content
API Reference
Records

Batch delete objects

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

POST/v2/prism/{teamId}/{objectType}/batch/delete

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

x-api-key<token>

Public API key generated from Micro settings. Sent as the x-api-key header and validated by AWS API Gateway in front of the service.

In: header

Path Parameters

teamId*string
Formatuuid
objectType*string

Object types that support CRUD, query, list, and per-type property metadata. GET /v2/prism/{teamId}/properties (list-all) also returns definitions for pipeline-owned types that are not in this set — including message, thread, and linkedin_thread. Those types are not queryable. Contacts expose last_email as a ref_message; you cannot query message to follow it.

Value in

  • "comment"
  • "deal"
  • "engagement"
  • "identity"
  • "ai_chat_thread"
  • "ai_chat_message"
  • "agent_site"
  • "document"
  • "action"
  • "event"
  • "organization"
  • "contact"

Header Parameters

Idempotency-Key?string

A unique key (UUID or any opaque string up to 255 chars) for an authenticated POST, PUT, or PATCH request. The server retains the initial claim for 24 hours and replays a completed non-5xx response only when the method, path, and request body all match. Reusing a non-expired key with a different method, path, or body returns 409 idempotency_key_mismatch; reusing it after expiry returns 409 idempotency_key_stale, so use a new key. Replays include the idempotent-replay: true response header.

Length1 <= length <= 255

Request Body

application/json

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://developers.micro.so/v2/prism/${MICRO_TEAM_ID}/comment/batch/delete" \  -H "x-api-key: $MICRO_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "ids": [      "6e0346a3-e54d-40e3-9779-4ba1e707e35b"    ]  }'
{  "results": [    {      "id": "string",      "status": "ok",      "record": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "extended": {},        "default": {          "property1": null,          "property2": null        },        "list": {}      },      "error": {        "code": "string",        "message": "string"      }    }  ],  "summary": {    "total": 0,    "succeeded": 0,    "failed": 0  }}
micro.so