Guides

πŸ—‘οΈ [DELETE] Delete Face

Delete a Face in the collection.

Type : DELETE

Input Data (Qurey String):

KeyFormatRequiredDescription
collectionIdstringOThe unique ID of the collection to which the FACE ID you want to delete belongs.
faceIdstringOThe unique ID of the Face submission you want to delete.

Output Data:

KeyFormatDescription
messagestringThe success or error message.

Error (403)

Error codeError messageDescription
6039API Key is required.Missing API Key: x-api-key is missing in header
6040Access Denied: API Key is unavailable.Unregistered API Key: Access restriction

Error (400)

Error codeError messageDescription
6018CollectionId is required.CollectionId is missing
6019FaceId is required.FaceId is missing
6020This collection is unavailable.The collection has already been deleted
6021Cannot find face dataIf face information does not exist
6022The face Id is not exist.Face information does not exist
6023Fail to delete face.Unspecified errors
  • Request Headers
x-api-key : "string"
  • Request Data
collectionId : "string"
faceId : "string"
  • Response
{
    "message": "Success"
}
  • Error Response
{
   errorCode: number,
   message: "string"
}