Replace integration credentials
curl --request POST \
--url https://apiv2.vodex.ai/v1/integrations/{id}/credentials \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"apiKeySid": "<string>",
"apiKeySecret": "<string>",
"authToken": "<string>",
"apiKey": "<string>",
"apiSecret": "<string>",
"authUsername": "<string>",
"authPassword": "<string>"
}
'import requests
url = "https://apiv2.vodex.ai/v1/integrations/{id}/credentials"
payload = {
"apiKeySid": "<string>",
"apiKeySecret": "<string>",
"authToken": "<string>",
"apiKey": "<string>",
"apiSecret": "<string>",
"authUsername": "<string>",
"authPassword": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
apiKeySid: '<string>',
apiKeySecret: '<string>',
authToken: '<string>',
apiKey: '<string>',
apiSecret: '<string>',
authUsername: '<string>',
authPassword: '<string>'
})
};
fetch('https://apiv2.vodex.ai/v1/integrations/{id}/credentials', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apiv2.vodex.ai/v1/integrations/{id}/credentials",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'apiKeySid' => '<string>',
'apiKeySecret' => '<string>',
'authToken' => '<string>',
'apiKey' => '<string>',
'apiSecret' => '<string>',
'authUsername' => '<string>',
'authPassword' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://apiv2.vodex.ai/v1/integrations/{id}/credentials"
payload := strings.NewReader("{\n \"apiKeySid\": \"<string>\",\n \"apiKeySecret\": \"<string>\",\n \"authToken\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"authUsername\": \"<string>\",\n \"authPassword\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://apiv2.vodex.ai/v1/integrations/{id}/credentials")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"apiKeySid\": \"<string>\",\n \"apiKeySecret\": \"<string>\",\n \"authToken\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"authUsername\": \"<string>\",\n \"authPassword\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.vodex.ai/v1/integrations/{id}/credentials")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"apiKeySid\": \"<string>\",\n \"apiKeySecret\": \"<string>\",\n \"authToken\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"authUsername\": \"<string>\",\n \"authPassword\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"carrier": "<string>",
"name": "<string>",
"accountRef": "<string>",
"accountName": "<string>",
"status": "connected",
"lastError": "<string>",
"trunkId": "<string>",
"carrierTrunkSid": "<string>",
"terminationUri": "<string>",
"credentialFingerprint": "<string>",
"hasCredentials": true,
"secretsBackend": "secret-manager",
"provisioning": "api",
"displayName": "<string>",
"transferSupport": "supported",
"channel": "voice",
"sipUri": "<string>",
"connectedAt": 123
}{
"error": "not found"
}{
"error": "not found"
}Integrations
Replace integration credentials
Re-validated against the carrier, then written as a new Secret Manager
version under the same reference — so nothing downstream needs a row
change. The gateway trunk’s auth is updated in lockstep, as is the SMS
credential mirror for messaging carriers. A rejection marks the
integration status: "error" with lastError set.
POST
/
integrations
/
{id}
/
credentials
Replace integration credentials
curl --request POST \
--url https://apiv2.vodex.ai/v1/integrations/{id}/credentials \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"apiKeySid": "<string>",
"apiKeySecret": "<string>",
"authToken": "<string>",
"apiKey": "<string>",
"apiSecret": "<string>",
"authUsername": "<string>",
"authPassword": "<string>"
}
'import requests
url = "https://apiv2.vodex.ai/v1/integrations/{id}/credentials"
payload = {
"apiKeySid": "<string>",
"apiKeySecret": "<string>",
"authToken": "<string>",
"apiKey": "<string>",
"apiSecret": "<string>",
"authUsername": "<string>",
"authPassword": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
apiKeySid: '<string>',
apiKeySecret: '<string>',
authToken: '<string>',
apiKey: '<string>',
apiSecret: '<string>',
authUsername: '<string>',
authPassword: '<string>'
})
};
fetch('https://apiv2.vodex.ai/v1/integrations/{id}/credentials', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apiv2.vodex.ai/v1/integrations/{id}/credentials",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'apiKeySid' => '<string>',
'apiKeySecret' => '<string>',
'authToken' => '<string>',
'apiKey' => '<string>',
'apiSecret' => '<string>',
'authUsername' => '<string>',
'authPassword' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://apiv2.vodex.ai/v1/integrations/{id}/credentials"
payload := strings.NewReader("{\n \"apiKeySid\": \"<string>\",\n \"apiKeySecret\": \"<string>\",\n \"authToken\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"authUsername\": \"<string>\",\n \"authPassword\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://apiv2.vodex.ai/v1/integrations/{id}/credentials")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"apiKeySid\": \"<string>\",\n \"apiKeySecret\": \"<string>\",\n \"authToken\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"authUsername\": \"<string>\",\n \"authPassword\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.vodex.ai/v1/integrations/{id}/credentials")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"apiKeySid\": \"<string>\",\n \"apiKeySecret\": \"<string>\",\n \"authToken\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"authUsername\": \"<string>\",\n \"authPassword\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"carrier": "<string>",
"name": "<string>",
"accountRef": "<string>",
"accountName": "<string>",
"status": "connected",
"lastError": "<string>",
"trunkId": "<string>",
"carrierTrunkSid": "<string>",
"terminationUri": "<string>",
"credentialFingerprint": "<string>",
"hasCredentials": true,
"secretsBackend": "secret-manager",
"provisioning": "api",
"displayName": "<string>",
"transferSupport": "supported",
"channel": "voice",
"sipUri": "<string>",
"connectedAt": 123
}{
"error": "not found"
}{
"error": "not found"
}Authorizations
Tenant API key (vdx_live_…) as Authorization: Bearer.
Path Parameters
Body
application/json
Response
Rotated.
Twilio Account SID or carrier SIP host — safe to show.
Available options:
connected, error The trunk id inside the carrier's account (API-provisioned carriers).
Non-reversible; for display and audit only.
Example:
"secret-manager"
Available options:
api, manual Available options:
supported, verify, unsupported An sms integration has no trunk and no numbers.
Available options:
voice, sms