Skip to main content
POST
/
api
/
v2
/
createOrganization
Create a new organization
curl --request POST \
  --url https://api.vida.dev/api/v2/createOrganization \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "[email protected]",
  "orgName": "Acme Solar",
  "productPlanId": "pplan-basic-monthly",
  "externalAccountId": "external-org-12345",
  "externalBillingId": "billing-id-12345",
  "numberingProviders": [
    {
      "providerId": "Twilio",
      "default": true,
      "config": {
        "accountSid": "ACxxxx",
        "authToken": "tokenxxxx"
      }
    }
  ],
  "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"
      }
    }
  ]
}'
{
  "success": true,
  "message": "Organization created",
  "organization": {}
}

Authorizations

token
string
query
required

Query Parameters

targetResellerId
string
required

Body

application/json
orgName
string
required
Example:
email
string
Example:
productPlanId
string
Example:
externalAccountId
string
Example:
externalBillingId
string
Example:
numberingProviders
object[]
vidaPremium
boolean
Example:
smsEnabled
boolean
Example:
smsBrandId
string
Example:
smsCampaignId
string
Example:
integrations
object[]
Example:

Response

201 - application/json
success
boolean
Example:
message
string
Example:
organization
object