Skip to content

Delete Family

API Address:/v2/family/enduserapi/deleteFamily

Request Method:DELETE

Request Data Type:application/x-www-form-urlencoded

Response Data Type:*/*

API Description:Delete family

Request Parameters:

Parameter NameParameter DescriptionRequest TypeRequiredData TypeSchema
fidFamily IDquerytruestring

Response Status:

Status CodeDescriptionSchema
200Family modified successfullyRegistration code response data
5041No permission
5618Please enter family ID
5622Family deletion failed
5629Cannot remove, at least one family must be retained
5635Home mode not enabled
6049Insufficient permission, current user is a regular member

Response Parameters:

Parameter NameParameter DescriptionTypeSchema
codeResponse status codeinteger(int32)integer(int32)
dataResponse dataobject
extMsgExtended messagestring
msgResponse messagestring

Response Example:

javascript
{
	"code": 0,
	"data": {},
	"extMsg": "",
	"msg": ""
}