Workspace

Invite a member

POSThttps://voxa.abhinavyadav.in/api/v1/invites

Emails an invite link. A newer invite to the same email replaces the older one. Plans cap members, counting pending invites.

Authorization

A signed-in member with the members.manage permission (Authorization: Bearer session token). API keys can’t do this.

Authorization: Bearermembers.manageworks before activation

Query parameters

timezonestringdefault: "Asia/Kolkata"

IANA time zone for every timestamp in the response (at, date, timestamp and *_at fields), as ISO 8601 with the offset. The X-Timezone header works too; the zone used comes back in the X-Timezone response header. An unknown zone is a 400.

Body application/json

emailstringrequired

roleenum<string>default: "viewer"

The role the person gets on joining.

One of:owneradmindeveloperviewer

Response

201Success.

See the 201 example next to the code samples.

401No credentials, or they are invalid or revoked.

detailstring

What went wrong, in plain words.

403Your role (or an API key) lacks the permission.

detailstring

What went wrong, in plain words.

422Validation Error

detailobject[]

Show item attributes

locstring | integer[]

msgstring

typestring

curl --request POST \
  --url 'https://voxa.abhinavyadav.in/api/v1/invites?timezone=Asia/Kolkata' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "asha@example.com",
  "role": "developer"
}'

import requests

url = "https://voxa.abhinavyadav.in/api/v1/invites"
params = {
    "timezone": "Asia/Kolkata",
}
headers = {
    "Authorization": "Bearer <token>",
}
payload = {
    "email": "asha@example.com",
    "role": "developer",
}

response = requests.post(url, params=params, headers=headers, json=payload)
print(response.status_code, response.json())

const response = await fetch("https://voxa.abhinavyadav.in/api/v1/invites?timezone=Asia/Kolkata", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "email": "asha@example.com",
    "role": "developer"
  }),
})
const data = await response.json()
console.log(response.status, data)

Response

{
  "id": "inv_1d2e…",
  "email": "asha@example.com",
  "role": "developer",
  "link": "/invite/Zk3…",
  "email_sent": true
}

{
  "detail": "sign in required"
}

{
  "detail": "your role cannot do this (members.manage)"
}

{
  "detail": [
    {
      "type": "missing",
      "loc": [
        "body",
        "name"
      ],
      "msg": "Field required",
      "input": {}
    }
  ]
}