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
}
'
import requests

url = "https://api.vida.dev/api/v2/member?token="

payload = {
"email": "admin@acmesolar.com",
"redirectUrl": "https://vida.io/welcome",
"role": "admin",
"permittedAccountIds": [12345, 67890],
"sendWelcomeEmail": True
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
email: 'admin@acmesolar.com',
redirectUrl: 'https://vida.io/welcome',
role: 'admin',
permittedAccountIds: [12345, 67890],
sendWelcomeEmail: true
})
};

fetch('https://api.vida.dev/api/v2/member?token=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vida.dev/api/v2/member?token=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => 'admin@acmesolar.com',
'redirectUrl' => 'https://vida.io/welcome',
'role' => 'admin',
'permittedAccountIds' => [
12345,
67890
],
'sendWelcomeEmail' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.vida.dev/api/v2/member?token="

payload := strings.NewReader("{\n \"email\": \"admin@acmesolar.com\",\n \"redirectUrl\": \"https://vida.io/welcome\",\n \"role\": \"admin\",\n \"permittedAccountIds\": [\n 12345,\n 67890\n ],\n \"sendWelcomeEmail\": true\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.vida.dev/api/v2/member?token=")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"admin@acmesolar.com\",\n \"redirectUrl\": \"https://vida.io/welcome\",\n \"role\": \"admin\",\n \"permittedAccountIds\": [\n 12345,\n 67890\n ],\n \"sendWelcomeEmail\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.vida.dev/api/v2/member?token=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"admin@acmesolar.com\",\n \"redirectUrl\": \"https://vida.io/welcome\",\n \"role\": \"admin\",\n \"permittedAccountIds\": [\n 12345,\n 67890\n ],\n \"sendWelcomeEmail\": true\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "message": "Invitation sent"
}

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"