Change a household member's age band, quiet hours, services or allowed names
What you can call today
Every example here runs against api.xovris.ai with a key from your account’s settings. GET /v1/health and GET /v1/public/status answer without one.
const url = 'https://api.xovris.ai/v1/household/members/example';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"problem":"string","member":{"id":"string","name":"string","band":"child","timeZone":"string","quiet":[{"days":[1],"from":"string","to":"string","why":"bedtime"}],"services":["string"],"allow":["string"],"block":["string"]}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://api.xovris.ai/v1/household/members/example \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "problem": "string", "member": { "id": "string", "name": "string", "band": "child", "timeZone": "string", "quiet": [ { "days": [ 1 ], "from": "string", "to": "string", "why": "bedtime" } ], "services": [ "string" ], "allow": [ "string" ], "block": [ "string" ] } }'Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Request Body
Section titled “Request Body”object
object
object
Example
{ "problem": "string", "member": { "id": "string", "name": "string", "band": "child", "timeZone": "string", "quiet": [ { "days": [ 1 ], "from": "string", "to": "string", "why": "bedtime" } ], "services": [ "string" ], "allow": [ "string" ], "block": [ "string" ] }}Responses
Section titled “Responses”Done.
object
object
object
Example
{ "member": { "block": [ "string" ], "allow": [ "string" ], "services": [ "string" ], "quiet": [ { "days": [ 1 ], "from": "string", "to": "string", "why": "bedtime" } ], "id": "string", "name": "string", "band": "child", "timeZone": "string" }, "version": 1, "decisionId": "string", "next": "string"}Not signed in: the token is missing, expired or revoked. The answer says how to get a new one.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}Signed in, but this token or role may not do this. The answer names the permission it needs.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}Nothing with that id here, or it belongs to another workspace. Nothing was changed.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}default
Section titled “default”Any other refusal or failure. The answer says what happened and what to do next.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}Your data is never used to train our AI. How your data is kept
A problem is called fixed only once it works again. How each fix is checked
XOVRIS LTD, registered in England and Wales, company number 17499910. Registered office: 66 Paul Street, London EC2A 4NA.