Custom Tables: Content

Delete row from a custom table (by table name and row id)

Deletes the row under the table resolved from tableName.

delete/v1/custom-table-data/{tableName}/{rowId}

Request

  • Base URL: https://api.finalpos.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.finalpos.com/v1/custom-table-data/{tableName}/{rowId}
  • Auth: API key in header x-api-key

Path parameters

tableNamestring required

Logical custom table name in kebab-case; must resolve for this company.

rowIdstring required

MongoDB ObjectId of the row; must belong to the resolved table.

Response

Small acknowledgement payload (DeleteResponseDto).

statusCodenumber required

HTTP status code

messagestring required

Message describing the result of the operation

Example response

{
  "statusCode": 200,
  "message": "Resource with Id 123 deleted successfully"
}

Changes

No recorded changes to this operation across all 1 revision of this API.