Vida AI Agent OS Documentation

Update Organization Settings

curl --request POST \
  --url 'https://api.vida.dev/api/v2/updateOrganization?token=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "active": true,
  "productPlanId": "someProductPlanId",
  "offeredProductPlanId": "someProductPlanId",
  "email": "admin@test.com",
  "orgName": "Test Organization",
  "smsEnabled": true,
  "smsBrandId": "XXXXXX",
  "smsCampaignId": "XXXXXX",
  "vidaPremium": true,
  "externalAccountId": "AC_XXXXXXX",
  "externalBillingId": "somebillingId",
  "hipaaSetting": "inherit",
  "orgAccountType": "customer"
}
'

import requests

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

payload = {
    "active": True,
    "productPlanId": "someProductPlanId",
    "offeredProductPlanId": "someProductPlanId",
    "email": "admin@test.com",
    "orgName": "Test Organization",
    "smsEnabled": True,
    "smsBrandId": "XXXXXX",
    "smsCampaignId": "XXXXXX",
    "vidaPremium": True,
    "externalAccountId": "AC_XXXXXXX",
    "externalBillingId": "somebillingId",
    "hipaaSetting": "inherit",
    "orgAccountType": "customer"
}
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({
    active: true,
    productPlanId: 'someProductPlanId',
    offeredProductPlanId: 'someProductPlanId',
    email: 'admin@test.com',
    orgName: 'Test Organization',
    smsEnabled: true,
    smsBrandId: 'XXXXXX',
    smsCampaignId: 'XXXXXX',
    vidaPremium: true,
    externalAccountId: 'AC_XXXXXXX',
    externalBillingId: 'somebillingId',
    hipaaSetting: 'inherit',
    orgAccountType: 'customer'
  })
};

fetch('https://api.vida.dev/api/v2/updateOrganization?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/updateOrganization?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([
    'active' => true,
    'productPlanId' => 'someProductPlanId',
    'offeredProductPlanId' => 'someProductPlanId',
    'email' => 'admin@test.com',
    'orgName' => 'Test Organization',
    'smsEnabled' => true,
    'smsBrandId' => 'XXXXXX',
    'smsCampaignId' => 'XXXXXX',
    'vidaPremium' => true,
    'externalAccountId' => 'AC_XXXXXXX',
    'externalBillingId' => 'somebillingId',
    'hipaaSetting' => 'inherit',
    'orgAccountType' => 'customer'
  ]),
  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/updateOrganization?token="

	payload := strings.NewReader("{\n  \"active\": true,\n  \"productPlanId\": \"someProductPlanId\",\n  \"offeredProductPlanId\": \"someProductPlanId\",\n  \"email\": \"admin@test.com\",\n  \"orgName\": \"Test Organization\",\n  \"smsEnabled\": true,\n  \"smsBrandId\": \"XXXXXX\",\n  \"smsCampaignId\": \"XXXXXX\",\n  \"vidaPremium\": true,\n  \"externalAccountId\": \"AC_XXXXXXX\",\n  \"externalBillingId\": \"somebillingId\",\n  \"hipaaSetting\": \"inherit\",\n  \"orgAccountType\": \"customer\"\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/updateOrganization?token=")
  .header("Content-Type", "application/json")
  .body("{\n  \"active\": true,\n  \"productPlanId\": \"someProductPlanId\",\n  \"offeredProductPlanId\": \"someProductPlanId\",\n  \"email\": \"admin@test.com\",\n  \"orgName\": \"Test Organization\",\n  \"smsEnabled\": true,\n  \"smsBrandId\": \"XXXXXX\",\n  \"smsCampaignId\": \"XXXXXX\",\n  \"vidaPremium\": true,\n  \"externalAccountId\": \"AC_XXXXXXX\",\n  \"externalBillingId\": \"somebillingId\",\n  \"hipaaSetting\": \"inherit\",\n  \"orgAccountType\": \"customer\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vida.dev/api/v2/updateOrganization?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  \"active\": true,\n  \"productPlanId\": \"someProductPlanId\",\n  \"offeredProductPlanId\": \"someProductPlanId\",\n  \"email\": \"admin@test.com\",\n  \"orgName\": \"Test Organization\",\n  \"smsEnabled\": true,\n  \"smsBrandId\": \"XXXXXX\",\n  \"smsCampaignId\": \"XXXXXX\",\n  \"vidaPremium\": true,\n  \"externalAccountId\": \"AC_XXXXXXX\",\n  \"externalBillingId\": \"somebillingId\",\n  \"hipaaSetting\": \"inherit\",\n  \"orgAccountType\": \"customer\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Organization settings updated",
  "updatedSettings": [
    "productPlanId",
    "externalBillingId"
  ]
}

POST

api

updateOrganization

Update Organization Settings

curl --request POST \
  --url 'https://api.vida.dev/api/v2/updateOrganization?token=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "active": true,
  "productPlanId": "someProductPlanId",
  "offeredProductPlanId": "someProductPlanId",
  "email": "admin@test.com",
  "orgName": "Test Organization",
  "smsEnabled": true,
  "smsBrandId": "XXXXXX",
  "smsCampaignId": "XXXXXX",
  "vidaPremium": true,
  "externalAccountId": "AC_XXXXXXX",
  "externalBillingId": "somebillingId",
  "hipaaSetting": "inherit",
  "orgAccountType": "customer"
}
'

import requests

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

payload = {
    "active": True,
    "productPlanId": "someProductPlanId",
    "offeredProductPlanId": "someProductPlanId",
    "email": "admin@test.com",
    "orgName": "Test Organization",
    "smsEnabled": True,
    "smsBrandId": "XXXXXX",
    "smsCampaignId": "XXXXXX",
    "vidaPremium": True,
    "externalAccountId": "AC_XXXXXXX",
    "externalBillingId": "somebillingId",
    "hipaaSetting": "inherit",
    "orgAccountType": "customer"
}
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({
    active: true,
    productPlanId: 'someProductPlanId',
    offeredProductPlanId: 'someProductPlanId',
    email: 'admin@test.com',
    orgName: 'Test Organization',
    smsEnabled: true,
    smsBrandId: 'XXXXXX',
    smsCampaignId: 'XXXXXX',
    vidaPremium: true,
    externalAccountId: 'AC_XXXXXXX',
    externalBillingId: 'somebillingId',
    hipaaSetting: 'inherit',
    orgAccountType: 'customer'
  })
};

fetch('https://api.vida.dev/api/v2/updateOrganization?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/updateOrganization?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([
    'active' => true,
    'productPlanId' => 'someProductPlanId',
    'offeredProductPlanId' => 'someProductPlanId',
    'email' => 'admin@test.com',
    'orgName' => 'Test Organization',
    'smsEnabled' => true,
    'smsBrandId' => 'XXXXXX',
    'smsCampaignId' => 'XXXXXX',
    'vidaPremium' => true,
    'externalAccountId' => 'AC_XXXXXXX',
    'externalBillingId' => 'somebillingId',
    'hipaaSetting' => 'inherit',
    'orgAccountType' => 'customer'
  ]),
  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/updateOrganization?token="

	payload := strings.NewReader("{\n  \"active\": true,\n  \"productPlanId\": \"someProductPlanId\",\n  \"offeredProductPlanId\": \"someProductPlanId\",\n  \"email\": \"admin@test.com\",\n  \"orgName\": \"Test Organization\",\n  \"smsEnabled\": true,\n  \"smsBrandId\": \"XXXXXX\",\n  \"smsCampaignId\": \"XXXXXX\",\n  \"vidaPremium\": true,\n  \"externalAccountId\": \"AC_XXXXXXX\",\n  \"externalBillingId\": \"somebillingId\",\n  \"hipaaSetting\": \"inherit\",\n  \"orgAccountType\": \"customer\"\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/updateOrganization?token=")
  .header("Content-Type", "application/json")
  .body("{\n  \"active\": true,\n  \"productPlanId\": \"someProductPlanId\",\n  \"offeredProductPlanId\": \"someProductPlanId\",\n  \"email\": \"admin@test.com\",\n  \"orgName\": \"Test Organization\",\n  \"smsEnabled\": true,\n  \"smsBrandId\": \"XXXXXX\",\n  \"smsCampaignId\": \"XXXXXX\",\n  \"vidaPremium\": true,\n  \"externalAccountId\": \"AC_XXXXXXX\",\n  \"externalBillingId\": \"somebillingId\",\n  \"hipaaSetting\": \"inherit\",\n  \"orgAccountType\": \"customer\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vida.dev/api/v2/updateOrganization?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  \"active\": true,\n  \"productPlanId\": \"someProductPlanId\",\n  \"offeredProductPlanId\": \"someProductPlanId\",\n  \"email\": \"admin@test.com\",\n  \"orgName\": \"Test Organization\",\n  \"smsEnabled\": true,\n  \"smsBrandId\": \"XXXXXX\",\n  \"smsCampaignId\": \"XXXXXX\",\n  \"vidaPremium\": true,\n  \"externalAccountId\": \"AC_XXXXXXX\",\n  \"externalBillingId\": \"somebillingId\",\n  \"hipaaSetting\": \"inherit\",\n  \"orgAccountType\": \"customer\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Organization settings updated",
  "updatedSettings": [
    "productPlanId",
    "externalBillingId"
  ]
}

Authorizations

token

string

query

required

Vida API Token

Query Parameters

targetOrganizationId

string

required

Target Organization Id to update settings for

Body

application/json

active

boolean

Account status - if set to false calls and messages for all agents in this org will no longer be answered

Example:

true

productPlanId

string

Change Product Plan Id on the Organization. Note: if the target product plan is tied to a Stripe or Chargebee product and the customer has not yet subscribed - this will not work. Give the customer an offered product plan first. Otherwise - this will update the product plan on Vida and in the configured billing system.

Example:

"someProductPlanId"

offeredProductPlanId

string

Give an offer of a product plan to a customer. Useful when offering a private plan before the customer has completed checkout. Set null to remove it

Example:

"someProductPlanId"

string

Change main owner Email Of the Organization

Example:

"admin@test.com"

orgName

string

Change Organization Name

Example:

"Test Organization"

smsEnabled

boolean

Enable SMS Capabilities on the agent.

Example:

true

smsBrandId

string

SMS Brand Id that is registered for the organization

Example:

"XXXXXX"

smsCampaignId

string

Approved SMS Campaign Id for the organizations traffic

Example:

"XXXXXX"

vidaPremium

boolean

Indicates whether the account is in an unlocked (paid) state.

Example:

true

externalAccountId

string

External Account Id to match with your internal system account Id. Set to null to remove it.

Example:

"AC_XXXXXXX"

externalBillingId

string

External Id to match with your internal billing system. Set to null to remove it.

Example:

"somebillingId"

hipaaSetting

enum<string>

default:inherit

HIPAA setting for this organization. on|off|inherit (inherit from reseller)

Available options:

on,

off,

inherit

orgAccountType

enum<string>

Organization account type (internal vs customer). Internal orgs are billed through reseller usage; customer orgs are eligible for full subscriptions. Defaults to customer.

Available options:

internal,

customer

Example:

"customer"

Response

At least one setting was successfully updated

success

boolean

Example:

true

message

string

Example:

"Organization settings updated"

updatedSettings

string[]

Example:

["orgName", "vidaPremium"]

failedSettings

string[] | null

Example:

["email"]

API Documentation

Agent API Guides

Platform API Guides

Authorization

Agents

Phone Numbers

SIP

Messaging

Webhooks

Knowledge

Agent URLs

Accounts

Billing

Tasks

Integrations

Models

Contacts

White-label Domains

Conversation Logs

Conversations

Apps

Inbound Email

Features

Computer Agents

Computer Agent Sessions

Agent Templates

Update Organization Settings

Authorizations

Query Parameters

Body

Response