API Docs
Voxbi Cockpit APIs
All endpoints

Update and re-run the Odoo integration (pbx)

Patches the supplied fields on the authenticated PBX's Odoo integration and re-queues the install job (job status is reset to pending and previous results are cleared). Every field is optional; only the fields you send are changed. The PBX is resolved from the API key. Requires an API key carrying the odoo-installer ability.

HTTP: IntegrationApiKey

API key created on the Cockpit Integrations page (an "API key" integration). It is a bearer token owned by the customer's PBX and limited to the scopes selected when the key was created (e.g. phone-numbers, push-configuration).

Send it in the Authorization header:

Authorization: Bearer <api_key>

Manage keys (create / reveal / revoke) from Integrations → New integration → API key.

HTTP Authorization Scheme
bearer
accept header · string
example: application/json

Request body

Request schema
odoo_urlstring
length: 0–255
example: https://erp.example.com
odoo_dbstring
length: 0–128
example: example_prod
odoo_versionstring
length: 0–16
example: 17.0
service_userstring
length: 0–128
example: svc_voxbi
service_keystring
Odoo service account API key. Stored encrypted and never returned.
length: 0–255write-only
example: s3cr3t-service-key
service_uidinteger
example: 7
sync_sip_configurationsboolean
example: 1
is_activeboolean
example: 1
installer_module_versionstring
length: 0–32
example: 1.2.0

Responses

OK. The integration was updated and the install job re-queued.
Response schema
integration_idstring · uuid
job_statusstring
Always reset to `pending` on save.
enum: pending
status_urlstring · uri
Authorization Token Missing. This error is returned when the authorization token is missing.
Response schema
errorstring
Error message
example: Authorization Token is missing
No Odoo integration exists for the authenticated PBX.
Response schema
errorstring
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.
post https://cockpit.voxbi.com/api/v1/odoo-installer/update-and-fix-integration
Base URL
Request sample 
curl -X POST 'https://cockpit.voxbi.com/api/v1/odoo-installer/update-and-fix-integration' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data '{"odoo_version":"17.0","is_active":true}'
const response = await fetch('https://cockpit.voxbi.com/api/v1/odoo-installer/update-and-fix-integration', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${YOUR_TOKEN}`,
  },
  body: JSON.stringify({
    "odoo_version": "17.0",
    "is_active": true
}),
});

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

response = requests.post('https://cockpit.voxbi.com/api/v1/odoo-installer/update-and-fix-integration',
    headers={'Authorization': f'Bearer {YOUR_TOKEN}'},
    json={
    "odoo_version": "17.0",
    "is_active": true
}
)
response.raise_for_status()
data = response.json()
print(data)
<?php
$context = stream_context_create([
    'http' => [
        'method'  => 'POST',
        'header'  => "Content-Type: application/json\r\nAuthorization: Bearer YOUR_TOKEN",
        'content' => '{
    \"odoo_version\": \"17.0\",
    \"is_active\": true
}',
    ],
]);

$response = file_get_contents('https://cockpit.voxbi.com/api/v1/odoo-installer/update-and-fix-integration', false, $context);
$data = json_decode($response, true);
print_r($data);
Sample request
{ … }
"odoo_version": "17.0",
"is_active": true
}
{ … }
"integration_id": "550e8400-e29b-41d4-a716-446655440000",
"job_status": "pending",
"status_url": "https://cockpit.voxbi.com/api/v1/odoo-installer/install-status"
}
{ … }
"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
{ … }
"error": "not_found"
}
{ … }
"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"
}