Set the caller's own name and relationship in a home, as the family and the device see them (root admin, main admins and members; parents use parent.putSlot / putProfile). Updates the member mirror record.
Input
application/jsondisplayName
string
Required
No description available.
maxLength: 64 byteshomeId
stringtid
Required
A timestamp-based identifier (TID).
relationship
string
Optional
No description available.
maxLength: 32 bytesOutput
application/jsonok
boolean
Required
No description available.
Errors
NotMember
HomeNotFound
Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"description": "Set the caller's own name and relationship in a home, as the family and the device see them (root admin, main admins and members; parents use parent.putSlot / putProfile). Updates the member mirror record.",
"errors": [
{
"name": "NotMember"
},
{
"name": "HomeNotFound"
}
],
"input": {
"encoding": "application/json",
"schema": {
"properties": {
"displayName": {
"maxLength": 64,
"type": "string"
},
"homeId": {
"format": "tid",
"type": "string"
},
"relationship": {
"maxLength": 32,
"type": "string"
}
},
"required": [
"homeId",
"displayName"
],
"type": "object"
}
},
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"ok": {
"type": "boolean"
}
},
"required": [
"ok"
],
"type": "object"
}
},
"type": "procedure"
}