Skip to main content
POST
/
api
/
v2
/
member
Invite member
curl --request POST \
  --url 'https://api.vida.dev/api/v2/member?token=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "admin@acmesolar.com",
  "redirectUrl": "https://vida.io/welcome",
  "role": "admin",
  "permittedAccountIds": [
    12345,
    67890
  ],
  "sendWelcomeEmail": true
}
'
{
  "success": true,
  "message": "Invitation sent"
}

Documentation Index

Fetch the complete documentation index at: https://vida.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
token
string
query
required

Vida API Token

Body

application/json
​
email
string
required

Email of the person you are inviting

Example:

"admin@acmesolar.com"

​
redirectUrl
string

URL to redirect user to after they accept invite

Example:

"https://vida.io/welcome"

​
role
string

Role for the invited member. Defaults to admin when not specified.

Example:

"admin"

​
permittedAccountIds
number[]

Account ids that this member can access

Example:
[12345, 67890]
​
sendWelcomeEmail
boolean

Whether to send the default welcome email. Defaults to true.

Example:

true

Response

201 - application/json

Invitation sent

​
success
boolean
Example:

true

​
message
string
Example:

"Invitation sent"