curl --request PATCH \
--url https://api.photon.codes/v1/projects/{id}/platforms/voice/profiles/{profileId}/inbound \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expectedVersion": 123,
"credentials": {
"password": "<string>",
"username": "<string>"
},
"destinationUri": "<string>"
}
'import requests
url = "https://api.photon.codes/v1/projects/{id}/platforms/voice/profiles/{profileId}/inbound"
payload = {
"expectedVersion": 123,
"credentials": {
"password": "<string>",
"username": "<string>"
},
"destinationUri": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expectedVersion: 123,
credentials: {password: '<string>', username: '<string>'},
destinationUri: '<string>'
})
};
fetch('https://api.photon.codes/v1/projects/{id}/platforms/voice/profiles/{profileId}/inbound', 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://api.photon.codes/v1/projects/{id}/platforms/voice/profiles/{profileId}/inbound",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'expectedVersion' => 123,
'credentials' => [
'password' => '<string>',
'username' => '<string>'
],
'destinationUri' => '<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://api.photon.codes/v1/projects/{id}/platforms/voice/profiles/{profileId}/inbound"
payload := strings.NewReader("{\n \"expectedVersion\": 123,\n \"credentials\": {\n \"password\": \"<string>\",\n \"username\": \"<string>\"\n },\n \"destinationUri\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.photon.codes/v1/projects/{id}/platforms/voice/profiles/{profileId}/inbound")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"expectedVersion\": 123,\n \"credentials\": {\n \"password\": \"<string>\",\n \"username\": \"<string>\"\n },\n \"destinationUri\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.photon.codes/v1/projects/{id}/platforms/voice/profiles/{profileId}/inbound")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expectedVersion\": 123,\n \"credentials\": {\n \"password\": \"<string>\",\n \"username\": \"<string>\"\n },\n \"destinationUri\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"inbound": {
"credentials": {
"username": "<string>"
},
"destinationUri": "<string>"
},
"profileVersion": 123
}{
"code": "NOT_AUTHENTICATED",
"status": 401,
"title": "Not Authenticated",
"type": "https://photon.codes/docs/problems/not-authenticated"
}{
"code": "FORBIDDEN",
"status": 403,
"title": "Forbidden",
"type": "https://photon.codes/docs/problems/forbidden"
}{
"code": "VOICE_PROFILE_NOT_FOUND",
"status": 404,
"title": "Voice Profile Not Found",
"type": "https://photon.codes/docs/problems/voice-profile-not-found"
}{
"code": "PROJECT_CLOSING",
"status": 409,
"title": "Project Is Closing",
"type": "https://photon.codes/docs/problems/project-closing"
}{
"code": "VALIDATION_FAILED",
"issues": [
{
"code": "invalid_type",
"location": "json",
"message": "Expected a string.",
"path": "/name"
}
],
"status": 422,
"title": "Request Validation Failed",
"type": "https://photon.codes/docs/problems/validation-failed"
}{
"code": "RATE_LIMITED",
"status": 429,
"title": "Too Many Requests",
"type": "https://photon.codes/docs/problems/rate-limited"
}{
"code": "INTERNAL_ERROR",
"status": 500,
"title": "Internal Server Error",
"type": "https://photon.codes/docs/problems/internal-error"
}{
"code": "UPSTREAM_FAILURE",
"status": 502,
"title": "Upstream Service Failure",
"type": "https://photon.codes/docs/problems/upstream-failure"
}{
"code": "UPSTREAM_UNAVAILABLE",
"status": 503,
"title": "Upstream Service Unavailable",
"type": "https://photon.codes/docs/problems/upstream-unavailable"
}{
"code": "REQUEST_TIMEOUT",
"status": 504,
"title": "Request Timeout",
"type": "https://photon.codes/docs/problems/request-timeout"
}Update Voice inbound configuration
Updates selected fields of a profile’s inbound destination when the shared profile version matches. The profileId may identify the default or an additional profile. At least one of destinationUri or credentials is required. Credential omission preserves destination authentication, null removes it, and an object replaces it atomically. Requires platforms:write bound to the path project.
curl --request PATCH \
--url https://api.photon.codes/v1/projects/{id}/platforms/voice/profiles/{profileId}/inbound \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expectedVersion": 123,
"credentials": {
"password": "<string>",
"username": "<string>"
},
"destinationUri": "<string>"
}
'import requests
url = "https://api.photon.codes/v1/projects/{id}/platforms/voice/profiles/{profileId}/inbound"
payload = {
"expectedVersion": 123,
"credentials": {
"password": "<string>",
"username": "<string>"
},
"destinationUri": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expectedVersion: 123,
credentials: {password: '<string>', username: '<string>'},
destinationUri: '<string>'
})
};
fetch('https://api.photon.codes/v1/projects/{id}/platforms/voice/profiles/{profileId}/inbound', 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://api.photon.codes/v1/projects/{id}/platforms/voice/profiles/{profileId}/inbound",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'expectedVersion' => 123,
'credentials' => [
'password' => '<string>',
'username' => '<string>'
],
'destinationUri' => '<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://api.photon.codes/v1/projects/{id}/platforms/voice/profiles/{profileId}/inbound"
payload := strings.NewReader("{\n \"expectedVersion\": 123,\n \"credentials\": {\n \"password\": \"<string>\",\n \"username\": \"<string>\"\n },\n \"destinationUri\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.photon.codes/v1/projects/{id}/platforms/voice/profiles/{profileId}/inbound")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"expectedVersion\": 123,\n \"credentials\": {\n \"password\": \"<string>\",\n \"username\": \"<string>\"\n },\n \"destinationUri\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.photon.codes/v1/projects/{id}/platforms/voice/profiles/{profileId}/inbound")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expectedVersion\": 123,\n \"credentials\": {\n \"password\": \"<string>\",\n \"username\": \"<string>\"\n },\n \"destinationUri\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"inbound": {
"credentials": {
"username": "<string>"
},
"destinationUri": "<string>"
},
"profileVersion": 123
}{
"code": "NOT_AUTHENTICATED",
"status": 401,
"title": "Not Authenticated",
"type": "https://photon.codes/docs/problems/not-authenticated"
}{
"code": "FORBIDDEN",
"status": 403,
"title": "Forbidden",
"type": "https://photon.codes/docs/problems/forbidden"
}{
"code": "VOICE_PROFILE_NOT_FOUND",
"status": 404,
"title": "Voice Profile Not Found",
"type": "https://photon.codes/docs/problems/voice-profile-not-found"
}{
"code": "PROJECT_CLOSING",
"status": 409,
"title": "Project Is Closing",
"type": "https://photon.codes/docs/problems/project-closing"
}{
"code": "VALIDATION_FAILED",
"issues": [
{
"code": "invalid_type",
"location": "json",
"message": "Expected a string.",
"path": "/name"
}
],
"status": 422,
"title": "Request Validation Failed",
"type": "https://photon.codes/docs/problems/validation-failed"
}{
"code": "RATE_LIMITED",
"status": 429,
"title": "Too Many Requests",
"type": "https://photon.codes/docs/problems/rate-limited"
}{
"code": "INTERNAL_ERROR",
"status": 500,
"title": "Internal Server Error",
"type": "https://photon.codes/docs/problems/internal-error"
}{
"code": "UPSTREAM_FAILURE",
"status": 502,
"title": "Upstream Service Failure",
"type": "https://photon.codes/docs/problems/upstream-failure"
}{
"code": "UPSTREAM_UNAVAILABLE",
"status": 503,
"title": "Upstream Service Unavailable",
"type": "https://photon.codes/docs/problems/upstream-unavailable"
}{
"code": "REQUEST_TIMEOUT",
"status": 504,
"title": "Request Timeout",
"type": "https://photon.codes/docs/problems/request-timeout"
}Authorizations
Account Service Key, prefixed with pho_ask_, sent as Authorization: Bearer <key>. Acts on behalf of its owning account, subject to the permissions and credential restrictions of each operation. Account access tokens and OAuth grants also use the Bearer header. In organizations that require SSO, Account Service Keys are not accepted for managing the organization's SSO settings, deleting the organization, or checking whether it can be deleted.
Body
Was this page helpful?