Remove records (bulk)

Remove multiple rows in one call. Body: { modelUuid, ids: [string, ...] }.

DELETE /storage/records/removeBulk

Remove records (bulk)

cURL

curl --request DELETE \
  --url https://api.getcargo.io/v1/storage/records/removeBulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "modelUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ids": [
    "<string>"
  ]
}
'

200

{
  "reason": "<string>"
}

Authorizations

Authorization · string · header · required

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

Body

application/json

Shape: { modelUuid, ids: [string, ...] }.

modelUuid · string<uuid> · required

Target model.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

ids · string[] · required

Record identifiers to remove. Up to 1000 per request.

Required array length: 1 - 1000 elements

Record identifier; set on the payload under the model id column slug.

Minimum string length: 1

Response

200

application/json

Successful response

Remove records (bulk) response

Remove records (bulk) response

Error response body schema (success is 204 with no body).

reason · string · required

Failure reason from record.remove.