Skip to main content
POST
/
sub-organizations
Create a new sub-account
curl --request POST \
  --url 'https://api.wavix.com/v1/sub-organizations?appid=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Company",
  "default_destinations": {
    "sms_endpoint": "https://examples.com/sms",
    "dlr_endpoint": "https://examples.com/dlr"
  }
}
'
{
  "id": 123,
  "created_at": "2023-06-15T10:30:00.000Z",
  "name": "Updated Company Name",
  "api_key": "abc123def456",
  "master_organization": 456,
  "status": "enabled",
  "default_destinations": {
    "sms_endpoint": "https://examples.com/sms",
    "dlr_endpoint": "https://examples.com/dlr"
  }
}

Authorizations

​
appid
string
query
required

An API key to authorize your request

Body

application/json

A new sub-account details

​
name
string
required

Company name

Maximum string length: 255
Example:

"Company name"

​
default_destinations
object

Default webhook URLs for inbound messages and delivery reports

Response

A sub-account craeted

A user response for sub-organizations

​
id
integer<int32>
required

Unique identifier of the user

Example:

123

​
created_at
string<date-time>
required

When the user was created

Example:

"2023-06-15T10:30:00.000Z"

​
name
string
required

Company name

Example:

"Company"

​
api_key
string
required

Active API key for the user

Example:

"abc123def456"

​
master_organization
integer<int32>
required

ID of the master organization

Example:

456

​
status
enum<string>
required

User status

Available options:
enabled,
disabled
Example:

"enabled"

​
default_destinations
object
required

Default endpoints for SMS and DLR