Create a new account
curl --request POST \
--url 'https://api.vida.dev/api/v2/createAccount?token=' \
--header 'Content-Type: application/json' \
--data '
{
"accountName": "Acme Solar Bay Area Support Agent",
"externalAccountId": "AC_12345",
"externalBillingId": "billing-id-6789",
"integrations": [
{
"appId": "some-app-id",
"appVersion": "v1",
"appData": {
"apiToken": "APIToken"
}
},
{
"appId": "another-example-app",
"appVersion": "v2",
"appData": {
"accountSid": "sidxxxxxxx",
"accountToken": "tokenxxxxxxx",
"apiUrl": "https://someurl.example"
}
}
]
}
'import requests
url = "https://api.vida.dev/api/v2/createAccount?token="
payload = {
"accountName": "Acme Solar Bay Area Support Agent",
"externalAccountId": "AC_12345",
"externalBillingId": "billing-id-6789",
"integrations": [
{
"appId": "some-app-id",
"appVersion": "v1",
"appData": { "apiToken": "APIToken" }
},
{
"appId": "another-example-app",
"appVersion": "v2",
"appData": {
"accountSid": "sidxxxxxxx",
"accountToken": "tokenxxxxxxx",
"apiUrl": "https://someurl.example"
}
}
]
}
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({
accountName: 'Acme Solar Bay Area Support Agent',
externalAccountId: 'AC_12345',
externalBillingId: 'billing-id-6789',
integrations: [
{appId: 'some-app-id', appVersion: 'v1', appData: {apiToken: 'APIToken'}},
{
appId: 'another-example-app',
appVersion: 'v2',
appData: {
accountSid: 'sidxxxxxxx',
accountToken: 'tokenxxxxxxx',
apiUrl: 'https://someurl.example'
}
}
]
})
};
fetch('https://api.vida.dev/api/v2/createAccount?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/createAccount?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([
'accountName' => 'Acme Solar Bay Area Support Agent',
'externalAccountId' => 'AC_12345',
'externalBillingId' => 'billing-id-6789',
'integrations' => [
[
'appId' => 'some-app-id',
'appVersion' => 'v1',
'appData' => [
'apiToken' => 'APIToken'
]
],
[
'appId' => 'another-example-app',
'appVersion' => 'v2',
'appData' => [
'accountSid' => 'sidxxxxxxx',
'accountToken' => 'tokenxxxxxxx',
'apiUrl' => 'https://someurl.example'
]
]
]
]),
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/createAccount?token="
payload := strings.NewReader("{\n \"accountName\": \"Acme Solar Bay Area Support Agent\",\n \"externalAccountId\": \"AC_12345\",\n \"externalBillingId\": \"billing-id-6789\",\n \"integrations\": [\n {\n \"appId\": \"some-app-id\",\n \"appVersion\": \"v1\",\n \"appData\": {\n \"apiToken\": \"APIToken\"\n }\n },\n {\n \"appId\": \"another-example-app\",\n \"appVersion\": \"v2\",\n \"appData\": {\n \"accountSid\": \"sidxxxxxxx\",\n \"accountToken\": \"tokenxxxxxxx\",\n \"apiUrl\": \"https://someurl.example\"\n }\n }\n ]\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/createAccount?token=")
.header("Content-Type", "application/json")
.body("{\n \"accountName\": \"Acme Solar Bay Area Support Agent\",\n \"externalAccountId\": \"AC_12345\",\n \"externalBillingId\": \"billing-id-6789\",\n \"integrations\": [\n {\n \"appId\": \"some-app-id\",\n \"appVersion\": \"v1\",\n \"appData\": {\n \"apiToken\": \"APIToken\"\n }\n },\n {\n \"appId\": \"another-example-app\",\n \"appVersion\": \"v2\",\n \"appData\": {\n \"accountSid\": \"sidxxxxxxx\",\n \"accountToken\": \"tokenxxxxxxx\",\n \"apiUrl\": \"https://someurl.example\"\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vida.dev/api/v2/createAccount?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 \"accountName\": \"Acme Solar Bay Area Support Agent\",\n \"externalAccountId\": \"AC_12345\",\n \"externalBillingId\": \"billing-id-6789\",\n \"integrations\": [\n {\n \"appId\": \"some-app-id\",\n \"appVersion\": \"v1\",\n \"appData\": {\n \"apiToken\": \"APIToken\"\n }\n },\n {\n \"appId\": \"another-example-app\",\n \"appVersion\": \"v2\",\n \"appData\": {\n \"accountSid\": \"sidxxxxxxx\",\n \"accountToken\": \"tokenxxxxxxx\",\n \"apiUrl\": \"https://someurl.example\"\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Account created",
"account": "New Account object"
}Accounts
Create a new account
Create a new account under your organization
POST
/
api
/
v2
/
createAccount
Create a new account
curl --request POST \
--url 'https://api.vida.dev/api/v2/createAccount?token=' \
--header 'Content-Type: application/json' \
--data '
{
"accountName": "Acme Solar Bay Area Support Agent",
"externalAccountId": "AC_12345",
"externalBillingId": "billing-id-6789",
"integrations": [
{
"appId": "some-app-id",
"appVersion": "v1",
"appData": {
"apiToken": "APIToken"
}
},
{
"appId": "another-example-app",
"appVersion": "v2",
"appData": {
"accountSid": "sidxxxxxxx",
"accountToken": "tokenxxxxxxx",
"apiUrl": "https://someurl.example"
}
}
]
}
'import requests
url = "https://api.vida.dev/api/v2/createAccount?token="
payload = {
"accountName": "Acme Solar Bay Area Support Agent",
"externalAccountId": "AC_12345",
"externalBillingId": "billing-id-6789",
"integrations": [
{
"appId": "some-app-id",
"appVersion": "v1",
"appData": { "apiToken": "APIToken" }
},
{
"appId": "another-example-app",
"appVersion": "v2",
"appData": {
"accountSid": "sidxxxxxxx",
"accountToken": "tokenxxxxxxx",
"apiUrl": "https://someurl.example"
}
}
]
}
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({
accountName: 'Acme Solar Bay Area Support Agent',
externalAccountId: 'AC_12345',
externalBillingId: 'billing-id-6789',
integrations: [
{appId: 'some-app-id', appVersion: 'v1', appData: {apiToken: 'APIToken'}},
{
appId: 'another-example-app',
appVersion: 'v2',
appData: {
accountSid: 'sidxxxxxxx',
accountToken: 'tokenxxxxxxx',
apiUrl: 'https://someurl.example'
}
}
]
})
};
fetch('https://api.vida.dev/api/v2/createAccount?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/createAccount?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([
'accountName' => 'Acme Solar Bay Area Support Agent',
'externalAccountId' => 'AC_12345',
'externalBillingId' => 'billing-id-6789',
'integrations' => [
[
'appId' => 'some-app-id',
'appVersion' => 'v1',
'appData' => [
'apiToken' => 'APIToken'
]
],
[
'appId' => 'another-example-app',
'appVersion' => 'v2',
'appData' => [
'accountSid' => 'sidxxxxxxx',
'accountToken' => 'tokenxxxxxxx',
'apiUrl' => 'https://someurl.example'
]
]
]
]),
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/createAccount?token="
payload := strings.NewReader("{\n \"accountName\": \"Acme Solar Bay Area Support Agent\",\n \"externalAccountId\": \"AC_12345\",\n \"externalBillingId\": \"billing-id-6789\",\n \"integrations\": [\n {\n \"appId\": \"some-app-id\",\n \"appVersion\": \"v1\",\n \"appData\": {\n \"apiToken\": \"APIToken\"\n }\n },\n {\n \"appId\": \"another-example-app\",\n \"appVersion\": \"v2\",\n \"appData\": {\n \"accountSid\": \"sidxxxxxxx\",\n \"accountToken\": \"tokenxxxxxxx\",\n \"apiUrl\": \"https://someurl.example\"\n }\n }\n ]\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/createAccount?token=")
.header("Content-Type", "application/json")
.body("{\n \"accountName\": \"Acme Solar Bay Area Support Agent\",\n \"externalAccountId\": \"AC_12345\",\n \"externalBillingId\": \"billing-id-6789\",\n \"integrations\": [\n {\n \"appId\": \"some-app-id\",\n \"appVersion\": \"v1\",\n \"appData\": {\n \"apiToken\": \"APIToken\"\n }\n },\n {\n \"appId\": \"another-example-app\",\n \"appVersion\": \"v2\",\n \"appData\": {\n \"accountSid\": \"sidxxxxxxx\",\n \"accountToken\": \"tokenxxxxxxx\",\n \"apiUrl\": \"https://someurl.example\"\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vida.dev/api/v2/createAccount?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 \"accountName\": \"Acme Solar Bay Area Support Agent\",\n \"externalAccountId\": \"AC_12345\",\n \"externalBillingId\": \"billing-id-6789\",\n \"integrations\": [\n {\n \"appId\": \"some-app-id\",\n \"appVersion\": \"v1\",\n \"appData\": {\n \"apiToken\": \"APIToken\"\n }\n },\n {\n \"appId\": \"another-example-app\",\n \"appVersion\": \"v2\",\n \"appData\": {\n \"accountSid\": \"sidxxxxxxx\",\n \"accountToken\": \"tokenxxxxxxx\",\n \"apiUrl\": \"https://someurl.example\"\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Account created",
"account": "New Account object"
}Authorizations
Vida API Token
Query Parameters
Organization Id to create account in
Body
application/json
Account Name
Example:
"Acme Solar Bay Area Support Agent"
External Account Id to match with your internal system account Id
Example:
"AC_12345"
External Id to match with your internal billing system
Example:
"billing-id-6789"
Optional list of third-party app integrations to set up at org creation
Show child attributes
Show child attributes
Example:
[
{
"appId": "some-app-id",
"appVersion": "v1",
"appData": { "apiToken": "APIToken" }
},
{
"appId": "another-example-app",
"appVersion": "v2",
"appData": {
"accountSid": "sidxxxxxxx",
"accountToken": "tokenxxxxxxx",
"apiUrl": "https://someurl.example"
}
}
]
⌘I