Delete entity record

Delete an entity record in an Entity.

If more than 1 record is found by search_by, we delete all records that were found. You can add as many search_by parameters as you want to narrow down the search.

Endpoint

DELETE /api/v1/external/projects/{projectUuid}/entities/{entityId}/records

Headers

Header	Type	Required	Description
Authorization	string	Yes	Bearer token for authentication
Accept	string	No	Must be application/json

Request Body

The request should be sent as application/json with the following fields:

Field	Type	Required	Description
search_by	object	Yes	Object containing search criteria
search_by.[key]	string	Yes	The key to search by
search_by.[value]	string	Yes	The value to search for

Parameters

Parameter	Type	Required	Description
projectUuid	string	Yes	The UUID of the project to upload the document to. Can be found in the Recognito application.
entityId	string	Yes	The ID of the entity to create the record in. Can be found in the Recognito application.

Response

Success Response (200 OK)

{
  "status": "done",
  "entityRecordsDeleted": 5
}

Error Response (400 Bad Request)

{
  "error": "string",
  "message": "string"
}

Example

Request

curl -X PUT https://apiv2.recognito.io/api/v1/external/projects/{projectUuid}/entities/{entityId}/records \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "search_by": {
      "email": "john.doe@example.com",
      "invoice_number": "INV-12345"
    }
  }'

Response

{
  "status": "done",
  "entityRecordsDeleted": 1
}