Skip to main content
PUT
/
v1
/
sub-organizations
/
{id}
Update a sub-account
curl --request PUT \
  --url https://api.wavix.com/v1/sub-organizations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Company Name",
  "status": "enabled",
  "default_destinations": {
    "sms_endpoint": "https://examples.com/sms",
    "dlr_endpoint": "https://examples.com/dlr"
  }
}
'
{
  "id": 123,
  "created_at": "2023-06-15T10:30:00Z",
  "name": "My sub-account",
  "api_key": "abc123def456",
  "master_organization": 456,
  "status": "enabled",
  "default_destinations": {
    "sms_endpoint": "https://examples.com/sms",
    "dlr_endpoint": "https://examples.com/dlr"
  }
}

Authorizations

​
Authorization
string
header
required

Wavix API key. Pass as Authorization: Bearer <api_key>. Keys support per-resource scopes (none / read / write). See Restricted keys and scopes.

Path Parameters

​
id
integer<int32>
required

The unique ID of the sub-account.

Example:

123

Body

application/json

Full replacement of the sub-account. Omitted fields revert to their defaults.

​
name
string
required

Sub-account name.

Maximum string length: 255
Example:

"Updated Company Name"

​
status
enum<string>

Status of the subaccount. One of enabled (the subaccount is active and can be used) or disabled (the subaccount is suspended).

Available options:
enabled,
disabled
Example:

"enabled"

​
default_destinations
object

Default webhook URLs for inbound messages and delivery reports.

Response

Returns the updated sub-account.

Sub-account details including API key and webhook configurations.

​
id
integer<int32>
required

Sub-account ID.

Example:

123

​
created_at
string<date-time>
required

Date and time the sub-account was created in ISO 8601 format.

Example:

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

​
name
string
required

Sub-account name.

Example:

"My sub-account"

​
api_key
string
required

Sub-account API key.

Example:

"abc123def456"

​
master_organization
integer<int32>
required

Master account ID.

Example:

456

​
status
enum<string>
required

Status of the subaccount. One of enabled (the subaccount is active and can be used) or disabled (the subaccount is suspended).

Available options:
enabled,
disabled
Example:

"enabled"

​
default_destinations
object
required

Default webhook URLs for inbound messages and delivery reports.