Delete

Deletes one document by a specified document id or filter.

Use this API method when you want to find one document by a specified filter or id and delete it. If many documents are found, only the first one will be deleted.

[DeleteOne] - Deletes one document by a specified document id.

Delete one document by its id. Please do not specify any filter if you want to delete by id. If filter is specified, then id is ignored. https://docs.codemash.io/api/database/collections/delete

delete

/{version}/db/{CollectionName}//{Id}

Authorizations

Path parameters

Idanyrequired

Id of a record to delete. Required if filter is empty.

CollectionNameanyrequired

Collection name - unique, lowercased, collection name without whitespace. E.g., if your collection title you have entered in the CodeMash dashboard is "Business Trips" then collection name would be "business-trips".

versionanyrequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v2

Header parameters

Acceptanyrequired

Accept Header

X-CM-Clusterany

API key of your cluster. Can be passed in a header as X-CM-Cluster.

X-CM-ProjectIdanyrequired

ID of your project. Can be passed in a header as X-CM-ProjectId.

CultureCodeany

Specify culture code when your response from the API should be localised. E.g.: en

Body

Filterstring

Set the filter (in JSON format) to delete the first document found in the collection. Required when Id is not set.

IgnoreTriggersboolean

Ignore the delete trigger when executing one document deletion. When this property is set to "true", all delete triggers won't be executed.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.codemash.io//{version}/db/{CollectionName}/{Id}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'Filter=text&IgnoreTriggers=true'

200

200

{
  "response_status": {
    "error_code": "text",
    "message": "text",
    "stack_trace": "text",
    "meta": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "errors": [
      {
        "error_code": "text",
        "field_name": "text",
        "message": "text",
        "meta": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ]
  },
  "result": {
    "deletedCount": 1,
    "isAcknowledged": true
  }
}

Success

.NET

var client = new CodeMashClient(apiKey, projectId);
var service = new CodeMashRepository<Person>(client);

await service.DeleteOneAsync(
    x => x.Id == "record_id"
);

Check the information about entities on how your filter parameters are mapped.

Node

import { db } from 'codemash';

export async function deleteEmployee(id) {
    return await db.deleteRecord('employees', { _id: id });
}

PHP

use Codemash\CodemashClient;
use Codemash\CodemashDb;

class CodemashService
{
    protected CodemashDb $codemashDb;
    protected string $collectionName = '{YOUR_COLLECTION_NAME}';

    public function __construct()
    {
        $secretKey = '{YOUR_SECRET_KEY}';
        $projectId = '{YOUR_PROJECT_ID}';

        $client = new CodemashClient($secretKey, $projectId);
        $this->codemashDb = new CodemashDb($client);
    }

    public function deleteOne()
    {
        $responseData = $this->codemashDb->deleteOneWithFilter([
        	'collectionName' => 'employees',
        	'filter' => [
        		'email' => '[e-mail]',
        	],
        ]);
    }
}

Check the docs on how to form filters.