Skip to main content
POST
/
v1
/
platforms
/
me
/
invitations
Create invitation
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({email: 'jsmith@example.com', role_ids: [], send_email: true})
};

fetch('https://api.keystoneos.xyz/v1/platforms/me/invitations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "id": "<string>",
  "invitee_email": "<string>",
  "inviter_name": "<string>",
  "roles": [
    "<string>"
  ],
  "created_at": "<string>",
  "expires_at": "<string>",
  "invitation_url": "<string>"
}

Authorizations

Authorization
string
header
required

Auth0 JWT access token. See Authentication for details.

Body

application/json
email
string<email>
required
role_ids
string[]
send_email
boolean
default:true

Response

Successful Response

id
string
required
invitee_email
string
required
inviter_name
string
required
roles
string[]
required
created_at
string
required
expires_at
string
required
invitation_url
string | null