Skip to main content
POST
/
api
/
v2
/
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"
}
'
{
  "success": true,
  "message": "Organization settings updated",
  "updatedSettings": [
    "productPlanId",
    "externalBillingId"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://vida.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

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"

​
email
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"]