Skip to content

Save an on-call member's country, hours, skills and teams

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.

POST
/v1/oncall/members/{memberId}
curl --request POST \  --url https://api.xovris.ai/v1/oncall/members/example \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "country": "string", "region": "string", "skills": [ "string" ], "nightOk": true, "githubLogin": "string", "teams": [ "string" ], "hrIds": {}, "timeZone": "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.

memberId
required
string
Media typeapplication/json
object
country
string
region
One of:
string
skills
Array<string>
nightOk
boolean
githubLogin
One of:
string
teams
Array<string>
hrIds
object
key
additional properties
string
timeZone
string

Example

{  "country": "string",  "region": "string",  "skills": [    "string"  ],  "nightOk": true,  "githubLogin": "string",  "teams": [    "string"  ],  "hrIds": {},  "timeZone": "string"}

Done.

Media typeapplication/json
object
memberId
required
string
saved
required
boolean

Example

{  "memberId": "string",  "saved": true}

Not signed in: the token is missing, expired or revoked. The answer says how to get a new one.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

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.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

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.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Any other refusal or failure. The answer says what happened and what to do next.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Ask Xovris

Open the full page

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.