Skip to content

Accept an invitation as the address it was sent to and join the workspace in its role

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/invitations/accept
curl --request POST \  --url https://api.xovris.ai/v1/invitations/accept \  --header 'Content-Type: application/json' \  --data '{}'

Open to anyone, so no Idempotency-Key is kept: nobody is signed in to keep it for, and replaying one caller’s answer to another would hand it over.

No token needed: anyone may call this.

Media typeapplication/json
object

Example generated

{}

Done.

Media typeapplication/json
object
already
required
boolean
workspaceId
required
string
workspace
required
string
inviter
required
string
address
required
string
role
required
string
Allowed values: admin billing member viewer custom
roleName
required
One of:
string
can
required
Array<object>
object
id
required
string
words
required
string
of
required
number
endsAt
required
One of:
string
expiresAt
required
string

Example

{  "already": true,  "workspaceId": "string",  "workspace": "string",  "inviter": "string",  "address": "string",  "role": "admin",  "roleName": "string",  "can": [    {      "id": "string",      "words": "string"    }  ],  "of": 1,  "endsAt": "string",  "expiresAt": "string"}

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

Media typeapplication/json
object

Example generated

{}

Started: the answer says where to follow it.

Media typeapplication/json
object

Example generated

{}

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.