API Docs
Voxbi Cockpit APIs
All endpoints

Partially update a user-group

Partially updates the user group. Only the fields supplied in the request body are changed; others are left untouched.

HTTP: bearerAuth

User bearer token. Default authentication for customer-facing endpoints. Obtain a token by calling POST /login with your credentials, then send it on every subsequent request as Authorization: Bearer <token>. The token inherits the permissions and PBX scope of the authenticated user.

HTTP Authorization Scheme
bearer
Bearer format
Bearer <token>
id path · string · uuid *
UUID of the user-group
accept header · string
example: application/json

Request body · required

Request schema
name*string
example: Sales Team Updated
user_ids*array<string>
Full replacement set of member user IDs
[]string · uuid
positioninteger
example: 2

Responses

Response schema
dataobject
idstring · uuid
example: 550e8400-e29b-41d4-a716-446655440020
namestring
example: Sales Team Updated
positioninteger
example: 2
pbx_idstring · uuid
example: 550e8400-e29b-41d4-a716-446655440000
Authorization Token Missing. This error is returned when the authorization token is missing.
Response schema
errorstring
Error message
example: Authorization Token is missing
Data Not Found. This error is returned when the requested data is not found.
Response schema
messagearray<string>
[]string
Unprocessable Parameters. This error is returned when a parameter is not valid.
Response schema
messagestring
example: The given data was invalid.
errorsobject
filterarray<string>
[]string
sortarray<string>
[]string
pagearray<string>
[]string
per_pagearray<string>
[]string
Server error. An unexpected condition was encountered on the server and the request could not be completed. The body is a generic JSON envelope with a `message` field. The response is logged on the server side; quote the request URL + timestamp when reporting an issue.
Response schema
messagestring
exceptionstring
Only present in non-production environments.
filestring
Only present in non-production environments.
lineinteger
Only present in non-production environments.
patch https://cockpit.voxbi.com/api/v1/user-groups/{userGroupId}
Base URL
Request sample 
curl -X PATCH 'https://cockpit.voxbi.com/api/v1/user-groups/{userGroupId}' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data '{"name":"Sales Team Updated","user_ids":["550e8400-e29b-41d4-a716-446655440010","550e8400-e29b-41d4-a716-446655440011"],"position":2}'
const response = await fetch('https://cockpit.voxbi.com/api/v1/user-groups/{userGroupId}', {
  method: 'PATCH',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${YOUR_TOKEN}`,
  },
  body: JSON.stringify({
    "name": "Sales Team Updated",
    "user_ids": [
        "550e8400-e29b-41d4-a716-446655440010",
        "550e8400-e29b-41d4-a716-446655440011"
    ],
    "position": 2
}),
});

const data = await response.json();
console.log(data);
import requests

response = requests.patch('https://cockpit.voxbi.com/api/v1/user-groups/{userGroupId}',
    headers={'Authorization': f'Bearer {YOUR_TOKEN}'},
    json={
    "name": "Sales Team Updated",
    "user_ids": [
        "550e8400-e29b-41d4-a716-446655440010",
        "550e8400-e29b-41d4-a716-446655440011"
    ],
    "position": 2
}
)
response.raise_for_status()
data = response.json()
print(data)
<?php
$context = stream_context_create([
    'http' => [
        'method'  => 'PATCH',
        'header'  => "Content-Type: application/json\r\nAuthorization: Bearer YOUR_TOKEN",
        'content' => '{
    \"name\": \"Sales Team Updated\",
    \"user_ids\": [
        \"550e8400-e29b-41d4-a716-446655440010\",
        \"550e8400-e29b-41d4-a716-446655440011\"
    ],
    \"position\": 2
}',
    ],
]);

$response = file_get_contents('https://cockpit.voxbi.com/api/v1/user-groups/{userGroupId}', false, $context);
$data = json_decode($response, true);
print_r($data);
Sample request
{ … }
"name": "Sales Team Updated",
"user_ids": [ … ],
"550e8400-e29b-41d4-a716-446655440010",
"550e8400-e29b-41d4-a716-446655440011"
],
"position": 2
}
{ … }
"data": { … }
"id": "550e8400-e29b-41d4-a716-446655440020",
"name": "Sales Team Updated",
"position": 2,
"pbx_id": "550e8400-e29b-41d4-a716-446655440000"
}
}
Host string
example: cockpit.voxbi.com
Date string
example: Mon, 16 Oct 2023 14:08:48 GMT
Connection string
example: close
Cache-Control string
example: no-cache, private
Content-Type string
example: application/json
X-RateLimit-Limit integer
example: 60
X-RateLimit-Remaining integer
example: 59
Vary string
example: Origin
{ … }
"error": "Authorization Token is missing"
}
Cache-Control string
example: private, must-revalidate
Connection string
example: keep-alive
Content-Type string
example: application/json
Vary string
example: Origin
X-RateLimit-Limit integer
Max requests allowed in the current rate-limit window.
example: 60
X-RateLimit-Remaining integer
Requests remaining in the current rate-limit window.
example: 57
{ … }
"message": [ … ]
"Data not found"
]
}
Cache-Control string
example: private, must-revalidate
Connection string
example: keep-alive
Content-Type string
example: application/json
Vary string
example: Origin
X-RateLimit-Limit integer
Max requests allowed in the current rate-limit window.
example: 60
X-RateLimit-Remaining integer
Requests remaining in the current rate-limit window.
example: 57
{ … }
"errors": { … }
"filter": [ … ],
"The filter field must be an array."
],
"sort": [ … ],
"The sort field must be a string."
],
"page": [ … ],
"The page field must be an integer."
],
"per_page": [ … ]
"The per page field must be an integer."
]
}
}
Cache-Control string
example: private, must-revalidate
Connection string
example: keep-alive
Content-Type string
example: application/json
Vary string
example: Origin
X-RateLimit-Limit integer
Max requests allowed in the current rate-limit window.
example: 60
X-RateLimit-Remaining integer
Requests remaining in the current rate-limit window.
example: 57
{ … }
"message": "Server Error"
}