Skip to main content
POST
Invite member

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:
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"