Skip to content

Invite a person by their email address with a role - the email leaves at once, and asking again for the same address sends it again with a new link

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/members/invitations
curl --request POST \  --url https://api.xovris.ai/v1/members/invitations \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "email": null, "role": null, "roleId": null, "accessEndsAt": null }'

Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.

Media typeapplication/json
object
email
role
roleId
accessEndsAt

Example

{  "email": null,  "role": null,  "roleId": null,  "accessEndsAt": null}

Done.

Media typeapplication/json
object
mail
required
string
mailWords
required
One of:
string
outside
required
boolean
accessEndsAt
required
One of:
string
id
required
string
email
required
string
role
required
string
Allowed values: admin billing owner member viewer custom
expiresAt
required
One of:
string
again
required
boolean
refused

Example

{  "mail": "string",  "mailWords": "string",  "outside": true,  "accessEndsAt": "string",  "id": "string",  "email": "string",  "role": "admin",  "expiresAt": "string",  "again": true,  "refused": null}

Done: something new was made, and the answer is it.

Media typeapplication/json
object
mail
required
string
mailWords
required
One of:
string
outside
required
boolean
accessEndsAt
required
One of:
string
id
required
string
email
required
string
role
required
string
Allowed values: admin billing owner member viewer custom
expiresAt
required
One of:
string
again
required
boolean
refused

Example

{  "mail": "string",  "mailWords": "string",  "outside": true,  "accessEndsAt": "string",  "id": "string",  "email": "string",  "role": "admin",  "expiresAt": "string",  "again": true,  "refused": null}

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.