Docs - AI phone agents for SMB

Create a new organization

curl --request POST \
  --url 'https://api.vida.dev/api/v2/createOrganization?token=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "orgName": "Acme Solar",
  "email": "admin@acmesolar.com",
  "accountName": "Acme Support",
  "orgAccountType": "customer",
  "productPlanId": "pplan-basic-monthly",
  "offeredProductPlanId": "pplan-basic-monthly",
  "externalAccountId": "external-org-12345",
  "externalBillingId": "billing-id-12345",
  "hipaaSetting": "inherit",
  "numberingProviders": [
    {
      "providerId": "Twilio",
      "config": {
        "accountSid": "ACxxxx",
        "authToken": "tokenxxxx"
      },
      "default": true
    }
  ],
  "vidaPremium": true,
  "smsEnabled": true,
  "smsBrandId": "XXXXXX",
  "smsCampaignId": "XXXXXX",
  "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/createOrganization?token="

payload = {
    "orgName": "Acme Solar",
    "email": "admin@acmesolar.com",
    "accountName": "Acme Support",
    "orgAccountType": "customer",
    "productPlanId": "pplan-basic-monthly",
    "offeredProductPlanId": "pplan-basic-monthly",
    "externalAccountId": "external-org-12345",
    "externalBillingId": "billing-id-12345",
    "hipaaSetting": "inherit",
    "numberingProviders": [
        {
            "providerId": "Twilio",
            "config": {
                "accountSid": "ACxxxx",
                "authToken": "tokenxxxx"
            },
            "default": True
        }
    ],
    "vidaPremium": True,
    "smsEnabled": True,
    "smsBrandId": "XXXXXX",
    "smsCampaignId": "XXXXXX",
    "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({
    orgName: 'Acme Solar',
    email: 'admin@acmesolar.com',
    accountName: 'Acme Support',
    orgAccountType: 'customer',
    productPlanId: 'pplan-basic-monthly',
    offeredProductPlanId: 'pplan-basic-monthly',
    externalAccountId: 'external-org-12345',
    externalBillingId: 'billing-id-12345',
    hipaaSetting: 'inherit',
    numberingProviders: [
      {
        providerId: 'Twilio',
        config: {accountSid: 'ACxxxx', authToken: 'tokenxxxx'},
        default: true
      }
    ],
    vidaPremium: true,
    smsEnabled: true,
    smsBrandId: 'XXXXXX',
    smsCampaignId: 'XXXXXX',
    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/createOrganization?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/createOrganization?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([
    'orgName' => 'Acme Solar',
    'email' => 'admin@acmesolar.com',
    'accountName' => 'Acme Support',
    'orgAccountType' => 'customer',
    'productPlanId' => 'pplan-basic-monthly',
    'offeredProductPlanId' => 'pplan-basic-monthly',
    'externalAccountId' => 'external-org-12345',
    'externalBillingId' => 'billing-id-12345',
    'hipaaSetting' => 'inherit',
    'numberingProviders' => [
        [
                'providerId' => 'Twilio',
                'config' => [
                                'accountSid' => 'ACxxxx',
                                'authToken' => 'tokenxxxx'
                ],
                'default' => true
        ]
    ],
    'vidaPremium' => true,
    'smsEnabled' => true,
    'smsBrandId' => 'XXXXXX',
    'smsCampaignId' => 'XXXXXX',
    '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/createOrganization?token="

	payload := strings.NewReader("{\n  \"orgName\": \"Acme Solar\",\n  \"email\": \"admin@acmesolar.com\",\n  \"accountName\": \"Acme Support\",\n  \"orgAccountType\": \"customer\",\n  \"productPlanId\": \"pplan-basic-monthly\",\n  \"offeredProductPlanId\": \"pplan-basic-monthly\",\n  \"externalAccountId\": \"external-org-12345\",\n  \"externalBillingId\": \"billing-id-12345\",\n  \"hipaaSetting\": \"inherit\",\n  \"numberingProviders\": [\n    {\n      \"providerId\": \"Twilio\",\n      \"config\": {\n        \"accountSid\": \"ACxxxx\",\n        \"authToken\": \"tokenxxxx\"\n      },\n      \"default\": true\n    }\n  ],\n  \"vidaPremium\": true,\n  \"smsEnabled\": true,\n  \"smsBrandId\": \"XXXXXX\",\n  \"smsCampaignId\": \"XXXXXX\",\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/createOrganization?token=")
  .header("Content-Type", "application/json")
  .body("{\n  \"orgName\": \"Acme Solar\",\n  \"email\": \"admin@acmesolar.com\",\n  \"accountName\": \"Acme Support\",\n  \"orgAccountType\": \"customer\",\n  \"productPlanId\": \"pplan-basic-monthly\",\n  \"offeredProductPlanId\": \"pplan-basic-monthly\",\n  \"externalAccountId\": \"external-org-12345\",\n  \"externalBillingId\": \"billing-id-12345\",\n  \"hipaaSetting\": \"inherit\",\n  \"numberingProviders\": [\n    {\n      \"providerId\": \"Twilio\",\n      \"config\": {\n        \"accountSid\": \"ACxxxx\",\n        \"authToken\": \"tokenxxxx\"\n      },\n      \"default\": true\n    }\n  ],\n  \"vidaPremium\": true,\n  \"smsEnabled\": true,\n  \"smsBrandId\": \"XXXXXX\",\n  \"smsCampaignId\": \"XXXXXX\",\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/createOrganization?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  \"orgName\": \"Acme Solar\",\n  \"email\": \"admin@acmesolar.com\",\n  \"accountName\": \"Acme Support\",\n  \"orgAccountType\": \"customer\",\n  \"productPlanId\": \"pplan-basic-monthly\",\n  \"offeredProductPlanId\": \"pplan-basic-monthly\",\n  \"externalAccountId\": \"external-org-12345\",\n  \"externalBillingId\": \"billing-id-12345\",\n  \"hipaaSetting\": \"inherit\",\n  \"numberingProviders\": [\n    {\n      \"providerId\": \"Twilio\",\n      \"config\": {\n        \"accountSid\": \"ACxxxx\",\n        \"authToken\": \"tokenxxxx\"\n      },\n      \"default\": true\n    }\n  ],\n  \"vidaPremium\": true,\n  \"smsEnabled\": true,\n  \"smsBrandId\": \"XXXXXX\",\n  \"smsCampaignId\": \"XXXXXX\",\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": "Organization created",
  "organization": {}
}

POST

api

createOrganization

Create a new organization

curl --request POST \
  --url 'https://api.vida.dev/api/v2/createOrganization?token=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "orgName": "Acme Solar",
  "email": "admin@acmesolar.com",
  "accountName": "Acme Support",
  "orgAccountType": "customer",
  "productPlanId": "pplan-basic-monthly",
  "offeredProductPlanId": "pplan-basic-monthly",
  "externalAccountId": "external-org-12345",
  "externalBillingId": "billing-id-12345",
  "hipaaSetting": "inherit",
  "numberingProviders": [
    {
      "providerId": "Twilio",
      "config": {
        "accountSid": "ACxxxx",
        "authToken": "tokenxxxx"
      },
      "default": true
    }
  ],
  "vidaPremium": true,
  "smsEnabled": true,
  "smsBrandId": "XXXXXX",
  "smsCampaignId": "XXXXXX",
  "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/createOrganization?token="

payload = {
    "orgName": "Acme Solar",
    "email": "admin@acmesolar.com",
    "accountName": "Acme Support",
    "orgAccountType": "customer",
    "productPlanId": "pplan-basic-monthly",
    "offeredProductPlanId": "pplan-basic-monthly",
    "externalAccountId": "external-org-12345",
    "externalBillingId": "billing-id-12345",
    "hipaaSetting": "inherit",
    "numberingProviders": [
        {
            "providerId": "Twilio",
            "config": {
                "accountSid": "ACxxxx",
                "authToken": "tokenxxxx"
            },
            "default": True
        }
    ],
    "vidaPremium": True,
    "smsEnabled": True,
    "smsBrandId": "XXXXXX",
    "smsCampaignId": "XXXXXX",
    "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({
    orgName: 'Acme Solar',
    email: 'admin@acmesolar.com',
    accountName: 'Acme Support',
    orgAccountType: 'customer',
    productPlanId: 'pplan-basic-monthly',
    offeredProductPlanId: 'pplan-basic-monthly',
    externalAccountId: 'external-org-12345',
    externalBillingId: 'billing-id-12345',
    hipaaSetting: 'inherit',
    numberingProviders: [
      {
        providerId: 'Twilio',
        config: {accountSid: 'ACxxxx', authToken: 'tokenxxxx'},
        default: true
      }
    ],
    vidaPremium: true,
    smsEnabled: true,
    smsBrandId: 'XXXXXX',
    smsCampaignId: 'XXXXXX',
    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/createOrganization?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/createOrganization?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([
    'orgName' => 'Acme Solar',
    'email' => 'admin@acmesolar.com',
    'accountName' => 'Acme Support',
    'orgAccountType' => 'customer',
    'productPlanId' => 'pplan-basic-monthly',
    'offeredProductPlanId' => 'pplan-basic-monthly',
    'externalAccountId' => 'external-org-12345',
    'externalBillingId' => 'billing-id-12345',
    'hipaaSetting' => 'inherit',
    'numberingProviders' => [
        [
                'providerId' => 'Twilio',
                'config' => [
                                'accountSid' => 'ACxxxx',
                                'authToken' => 'tokenxxxx'
                ],
                'default' => true
        ]
    ],
    'vidaPremium' => true,
    'smsEnabled' => true,
    'smsBrandId' => 'XXXXXX',
    'smsCampaignId' => 'XXXXXX',
    '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/createOrganization?token="

	payload := strings.NewReader("{\n  \"orgName\": \"Acme Solar\",\n  \"email\": \"admin@acmesolar.com\",\n  \"accountName\": \"Acme Support\",\n  \"orgAccountType\": \"customer\",\n  \"productPlanId\": \"pplan-basic-monthly\",\n  \"offeredProductPlanId\": \"pplan-basic-monthly\",\n  \"externalAccountId\": \"external-org-12345\",\n  \"externalBillingId\": \"billing-id-12345\",\n  \"hipaaSetting\": \"inherit\",\n  \"numberingProviders\": [\n    {\n      \"providerId\": \"Twilio\",\n      \"config\": {\n        \"accountSid\": \"ACxxxx\",\n        \"authToken\": \"tokenxxxx\"\n      },\n      \"default\": true\n    }\n  ],\n  \"vidaPremium\": true,\n  \"smsEnabled\": true,\n  \"smsBrandId\": \"XXXXXX\",\n  \"smsCampaignId\": \"XXXXXX\",\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/createOrganization?token=")
  .header("Content-Type", "application/json")
  .body("{\n  \"orgName\": \"Acme Solar\",\n  \"email\": \"admin@acmesolar.com\",\n  \"accountName\": \"Acme Support\",\n  \"orgAccountType\": \"customer\",\n  \"productPlanId\": \"pplan-basic-monthly\",\n  \"offeredProductPlanId\": \"pplan-basic-monthly\",\n  \"externalAccountId\": \"external-org-12345\",\n  \"externalBillingId\": \"billing-id-12345\",\n  \"hipaaSetting\": \"inherit\",\n  \"numberingProviders\": [\n    {\n      \"providerId\": \"Twilio\",\n      \"config\": {\n        \"accountSid\": \"ACxxxx\",\n        \"authToken\": \"tokenxxxx\"\n      },\n      \"default\": true\n    }\n  ],\n  \"vidaPremium\": true,\n  \"smsEnabled\": true,\n  \"smsBrandId\": \"XXXXXX\",\n  \"smsCampaignId\": \"XXXXXX\",\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/createOrganization?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  \"orgName\": \"Acme Solar\",\n  \"email\": \"admin@acmesolar.com\",\n  \"accountName\": \"Acme Support\",\n  \"orgAccountType\": \"customer\",\n  \"productPlanId\": \"pplan-basic-monthly\",\n  \"offeredProductPlanId\": \"pplan-basic-monthly\",\n  \"externalAccountId\": \"external-org-12345\",\n  \"externalBillingId\": \"billing-id-12345\",\n  \"hipaaSetting\": \"inherit\",\n  \"numberingProviders\": [\n    {\n      \"providerId\": \"Twilio\",\n      \"config\": {\n        \"accountSid\": \"ACxxxx\",\n        \"authToken\": \"tokenxxxx\"\n      },\n      \"default\": true\n    }\n  ],\n  \"vidaPremium\": true,\n  \"smsEnabled\": true,\n  \"smsBrandId\": \"XXXXXX\",\n  \"smsCampaignId\": \"XXXXXX\",\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": "Organization created",
  "organization": {}
}

Authorizations

token

string

query

required

Vida API Token

Query Parameters

targetResellerId

string

required

Reseller-ID under which the org will be created

Body

application/json

orgName

string

required

Organization name

Example:

"Acme Solar"

string

Admin-user e-mail for the new org

Example:

"admin@acmesolar.com"

accountName

string

Default agent name for the organization

Example:

"Acme Support"

orgAccountType

enum<string>

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

Available options:

internal,

customer

Example:

"customer"

productPlanId

string

Product-plan ID. If omitted, defaults to your reseller sell-plan.

Example:

"pplan-basic-monthly"

offeredProductPlanId

string

Give an offered product plan to the organization (same behavior as updateOrganization)

Example:

"pplan-basic-monthly"

externalAccountId

string

Your own CRM/customer ID for this org

Example:

"external-org-12345"

externalBillingId

string

External Id to match with your internal billing system

Example:

"billing-id-12345"

hipaaSetting

enum<string>

default:inherit

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

Available options:

on,

off,

inherit

numberingProviders

object[]

Array of numbering provider configurations

Show child attributes

vidaPremium

boolean

Mark this account as an actively paying account

Example:

true

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"

integrations

object[]

Optional list of third-party app integrations to set up at org creation

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"
    }
  }
]

Response

201 - application/json

Organization successfully created

success

boolean

Example:

true

message

string

Example:

"Organization created"

organization

object

Created organization object

List resellers Delete an organization

⌘I

API Documentation

Authorization

Agents

Phone Numbers

SIP

Messaging

Webhooks

Knowledge

Agent URLs

Accounts

Billing

Tasks

Logs

Integrations

Models

Contacts

Create a new organization

Authorizations

Query Parameters

Body

Response