Skip to content

Modify Family

Interface Address:/v2/family/enduserapi/setFamily

Request Method:PUT

Request Data Type:application/json

Response Data Type:*/*

Interface Description:Modify Family

Request Parameters:

Parameter NameParameter DescriptionRequest TypeRequiredData Typeschema
fidFamily IDquerytruestring
familyCoordinatesFamily coordinatesqueryfalsestring
familyLocationFamily addressqueryfalsestring
familyNameFamily namequeryfalsestring

Response Status:

Status CodeDescriptionschema
200Family modified successfullyRegistration code response data
5041No permission
5616Family name already exists
5618Please enter Family ID
5621Failed to modify family
5633Coordinate format error
5635Home mode not enabled
5659Family name too long, please enter a family name within 256 characters
5660Family address too long, please enter a family address within 256 characters
6049Insufficient permissions, 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": ""
}