Update account details
curl --request POST \
--url 'https://api.vida.dev/api/v2/account?token=' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Ada Lovelace",
"partnerName": "<string>",
"resellerName": "<string>",
"orgName": "<string>",
"accountName": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"description": "<string>",
"image": "<string>",
"businessName": "<string>",
"businessAddress": "<string>",
"email": "jsmith@example.com",
"agentTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"settings": {
"reportingFields": [
{
"key": "appointment_booked",
"label": "Appointment booked",
"instructions": "True when the customer agrees to a specific appointment time.",
"values": {
"choices": [
"<string>"
]
}
}
],
"metrics": [
{}
],
"defaultOrgSettings": {
"metrics": [
{}
]
}
}
}
'import requests
url = "https://api.vida.dev/api/v2/account?token="
payload = {
"name": "Ada Lovelace",
"partnerName": "<string>",
"resellerName": "<string>",
"orgName": "<string>",
"accountName": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"description": "<string>",
"image": "<string>",
"businessName": "<string>",
"businessAddress": "<string>",
"email": "jsmith@example.com",
"agentTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"settings": {
"reportingFields": [
{
"key": "appointment_booked",
"label": "Appointment booked",
"instructions": "True when the customer agrees to a specific appointment time.",
"values": { "choices": ["<string>"] }
}
],
"metrics": [{}],
"defaultOrgSettings": { "metrics": [{}] }
}
}
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({
name: 'Ada Lovelace',
partnerName: '<string>',
resellerName: '<string>',
orgName: '<string>',
accountName: '<string>',
firstName: '<string>',
lastName: '<string>',
description: '<string>',
image: '<string>',
businessName: '<string>',
businessAddress: '<string>',
email: 'jsmith@example.com',
agentTypeId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
settings: {
reportingFields: [
{
key: 'appointment_booked',
label: 'Appointment booked',
instructions: 'True when the customer agrees to a specific appointment time.',
values: {choices: ['<string>']}
}
],
metrics: [{}],
defaultOrgSettings: {metrics: [{}]}
}
})
};
fetch('https://api.vida.dev/api/v2/account?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/account?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([
'name' => 'Ada Lovelace',
'partnerName' => '<string>',
'resellerName' => '<string>',
'orgName' => '<string>',
'accountName' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'description' => '<string>',
'image' => '<string>',
'businessName' => '<string>',
'businessAddress' => '<string>',
'email' => 'jsmith@example.com',
'agentTypeId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'settings' => [
'reportingFields' => [
[
'key' => 'appointment_booked',
'label' => 'Appointment booked',
'instructions' => 'True when the customer agrees to a specific appointment time.',
'values' => [
'choices' => [
'<string>'
]
]
]
],
'metrics' => [
[
]
],
'defaultOrgSettings' => [
'metrics' => [
[
]
]
]
]
]),
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/account?token="
payload := strings.NewReader("{\n \"name\": \"Ada Lovelace\",\n \"partnerName\": \"<string>\",\n \"resellerName\": \"<string>\",\n \"orgName\": \"<string>\",\n \"accountName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"description\": \"<string>\",\n \"image\": \"<string>\",\n \"businessName\": \"<string>\",\n \"businessAddress\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"agentTypeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"settings\": {\n \"reportingFields\": [\n {\n \"key\": \"appointment_booked\",\n \"label\": \"Appointment booked\",\n \"instructions\": \"True when the customer agrees to a specific appointment time.\",\n \"values\": {\n \"choices\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"metrics\": [\n {}\n ],\n \"defaultOrgSettings\": {\n \"metrics\": [\n {}\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/account?token=")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Ada Lovelace\",\n \"partnerName\": \"<string>\",\n \"resellerName\": \"<string>\",\n \"orgName\": \"<string>\",\n \"accountName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"description\": \"<string>\",\n \"image\": \"<string>\",\n \"businessName\": \"<string>\",\n \"businessAddress\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"agentTypeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"settings\": {\n \"reportingFields\": [\n {\n \"key\": \"appointment_booked\",\n \"label\": \"Appointment booked\",\n \"instructions\": \"True when the customer agrees to a specific appointment time.\",\n \"values\": {\n \"choices\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"metrics\": [\n {}\n ],\n \"defaultOrgSettings\": {\n \"metrics\": [\n {}\n ]\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vida.dev/api/v2/account?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 \"name\": \"Ada Lovelace\",\n \"partnerName\": \"<string>\",\n \"resellerName\": \"<string>\",\n \"orgName\": \"<string>\",\n \"accountName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"description\": \"<string>\",\n \"image\": \"<string>\",\n \"businessName\": \"<string>\",\n \"businessAddress\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"agentTypeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"settings\": {\n \"reportingFields\": [\n {\n \"key\": \"appointment_booked\",\n \"label\": \"Appointment booked\",\n \"instructions\": \"True when the customer agrees to a specific appointment time.\",\n \"values\": {\n \"choices\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"metrics\": [\n {}\n ],\n \"defaultOrgSettings\": {\n \"metrics\": [\n {}\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body{}Accounts
Update account details
Update selected profile details or supported settings for an account.
POST
/
api
/
v2
/
account
Update account details
curl --request POST \
--url 'https://api.vida.dev/api/v2/account?token=' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Ada Lovelace",
"partnerName": "<string>",
"resellerName": "<string>",
"orgName": "<string>",
"accountName": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"description": "<string>",
"image": "<string>",
"businessName": "<string>",
"businessAddress": "<string>",
"email": "jsmith@example.com",
"agentTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"settings": {
"reportingFields": [
{
"key": "appointment_booked",
"label": "Appointment booked",
"instructions": "True when the customer agrees to a specific appointment time.",
"values": {
"choices": [
"<string>"
]
}
}
],
"metrics": [
{}
],
"defaultOrgSettings": {
"metrics": [
{}
]
}
}
}
'import requests
url = "https://api.vida.dev/api/v2/account?token="
payload = {
"name": "Ada Lovelace",
"partnerName": "<string>",
"resellerName": "<string>",
"orgName": "<string>",
"accountName": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"description": "<string>",
"image": "<string>",
"businessName": "<string>",
"businessAddress": "<string>",
"email": "jsmith@example.com",
"agentTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"settings": {
"reportingFields": [
{
"key": "appointment_booked",
"label": "Appointment booked",
"instructions": "True when the customer agrees to a specific appointment time.",
"values": { "choices": ["<string>"] }
}
],
"metrics": [{}],
"defaultOrgSettings": { "metrics": [{}] }
}
}
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({
name: 'Ada Lovelace',
partnerName: '<string>',
resellerName: '<string>',
orgName: '<string>',
accountName: '<string>',
firstName: '<string>',
lastName: '<string>',
description: '<string>',
image: '<string>',
businessName: '<string>',
businessAddress: '<string>',
email: 'jsmith@example.com',
agentTypeId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
settings: {
reportingFields: [
{
key: 'appointment_booked',
label: 'Appointment booked',
instructions: 'True when the customer agrees to a specific appointment time.',
values: {choices: ['<string>']}
}
],
metrics: [{}],
defaultOrgSettings: {metrics: [{}]}
}
})
};
fetch('https://api.vida.dev/api/v2/account?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/account?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([
'name' => 'Ada Lovelace',
'partnerName' => '<string>',
'resellerName' => '<string>',
'orgName' => '<string>',
'accountName' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'description' => '<string>',
'image' => '<string>',
'businessName' => '<string>',
'businessAddress' => '<string>',
'email' => 'jsmith@example.com',
'agentTypeId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'settings' => [
'reportingFields' => [
[
'key' => 'appointment_booked',
'label' => 'Appointment booked',
'instructions' => 'True when the customer agrees to a specific appointment time.',
'values' => [
'choices' => [
'<string>'
]
]
]
],
'metrics' => [
[
]
],
'defaultOrgSettings' => [
'metrics' => [
[
]
]
]
]
]),
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/account?token="
payload := strings.NewReader("{\n \"name\": \"Ada Lovelace\",\n \"partnerName\": \"<string>\",\n \"resellerName\": \"<string>\",\n \"orgName\": \"<string>\",\n \"accountName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"description\": \"<string>\",\n \"image\": \"<string>\",\n \"businessName\": \"<string>\",\n \"businessAddress\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"agentTypeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"settings\": {\n \"reportingFields\": [\n {\n \"key\": \"appointment_booked\",\n \"label\": \"Appointment booked\",\n \"instructions\": \"True when the customer agrees to a specific appointment time.\",\n \"values\": {\n \"choices\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"metrics\": [\n {}\n ],\n \"defaultOrgSettings\": {\n \"metrics\": [\n {}\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/account?token=")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Ada Lovelace\",\n \"partnerName\": \"<string>\",\n \"resellerName\": \"<string>\",\n \"orgName\": \"<string>\",\n \"accountName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"description\": \"<string>\",\n \"image\": \"<string>\",\n \"businessName\": \"<string>\",\n \"businessAddress\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"agentTypeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"settings\": {\n \"reportingFields\": [\n {\n \"key\": \"appointment_booked\",\n \"label\": \"Appointment booked\",\n \"instructions\": \"True when the customer agrees to a specific appointment time.\",\n \"values\": {\n \"choices\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"metrics\": [\n {}\n ],\n \"defaultOrgSettings\": {\n \"metrics\": [\n {}\n ]\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vida.dev/api/v2/account?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 \"name\": \"Ada Lovelace\",\n \"partnerName\": \"<string>\",\n \"resellerName\": \"<string>\",\n \"orgName\": \"<string>\",\n \"accountName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"description\": \"<string>\",\n \"image\": \"<string>\",\n \"businessName\": \"<string>\",\n \"businessAddress\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"agentTypeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"settings\": {\n \"reportingFields\": [\n {\n \"key\": \"appointment_booked\",\n \"label\": \"Appointment booked\",\n \"instructions\": \"True when the customer agrees to a specific appointment time.\",\n \"values\": {\n \"choices\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"metrics\": [\n {}\n ],\n \"defaultOrgSettings\": {\n \"metrics\": [\n {}\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body{}Authorizations
Vida API Token
Query Parameters
Target account ID when acting on behalf of another account
Body
application/json
Full name
Example:
"Ada Lovelace"
Partner name (for partner accounts only)
Reseller name (for reseller accounts only)
Organization name
Account name
First name
Last name
Profile description
Profile image URL
Business name
Business address
Email address
Agent type to put this account on. Reseller or partner admins only. Must be a type available to the account's reseller.
Supported account-level reporting and dashboard settings. Existing settings outside the supplied fields are preserved; each supplied array is a complete replacement for that array.
Show child attributes
Show child attributes
Response
Updated account details
The response is of type object.