Delete multiple matrices

POST /v1/matrix/bulk-delete

Delete multiple matrices

cURL

curl --request POST \
  --url https://staging.api.us.aptlydone.com/matrix/v1/matrix/bulk-delete \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "matrixIds": [
    "83268f1d-f96f-4b1d-aa02-56c7654ab552",
    "d4bde8d3-9af5-4656-a38c-a119088ef295"
  ]
}
'

200

{
  "statusCode": 200,
  "timestamp": "2026-01-08T06:33:22.023Z",
  "message": "Success",
  "data": {
    "successCount": 5,
    "failureCount": 0,
    "successIds": [
      "a56a024f-fd34-4a20-9acd-e37cd0cc0eaf",
      "187a4a3b-1143-4d28-ac91-27abaa792198"
    ],
    "failures": {
      "059e7d97-73cf-452d-a306-55d9a920dfae": "Matrix not found",
      "170dea67-879a-4a91-9adb-a6e485833efe": "Unauthorized operation"
    }
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

matrixIds · string<uuid>[] · required

Array of matrix IDs to soft delete

Minimum array length: 1

Example:

[
  "83268f1d-f96f-4b1d-aa02-56c7654ab552",
  "d4bde8d3-9af5-4656-a38c-a119088ef295"
]

Response

200

application/json

Matrices soft deleted successfully

statusCode · number · required

HTTP Status code

Example:

200

timestamp · string · required

Timestamp of the response

Example:

"2026-01-08T06:33:22.023Z"

message · string · required

Response message

Example:

"Success"

data · object · required

Response data

Show child attributes