curl --request PATCH \
--url https://api.goyappr.com/sip-endpoints/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"inbound_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_active": true,
"allowed_source_ips": [
"<string>"
]
}
'import requests
url = "https://api.goyappr.com/sip-endpoints/{id}"
payload = {
"name": "<string>",
"inbound_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_active": True,
"allowed_source_ips": ["<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({
name: '<string>',
inbound_agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
is_active: true,
allowed_source_ips: ['<string>']
})
};
fetch('https://api.goyappr.com/sip-endpoints/{id}', 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.goyappr.com/sip-endpoints/{id}",
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([
'name' => '<string>',
'inbound_agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'is_active' => true,
'allowed_source_ips' => [
'<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.goyappr.com/sip-endpoints/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"inbound_agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"is_active\": true,\n \"allowed_source_ips\": [\n \"<string>\"\n ]\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.goyappr.com/sip-endpoints/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"inbound_agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"is_active\": true,\n \"allowed_source_ips\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.goyappr.com/sip-endpoints/{id}")
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 \"name\": \"<string>\",\n \"inbound_agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"is_active\": true,\n \"allowed_source_ips\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "After-hours",
"slug": "after-hours-bz3r3mtypuwuw8tpdw3x392s",
"inbound_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_active": true,
"last_call_at": "2023-11-07T05:31:56Z",
"allowed_source_ips": [
"203.0.113.0/24"
],
"sip_uri": "sip:after-hours-bz3r3mtypuwuw8tpdw3x392s@yappr-byoc.sip.telnyx.com",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}Update SIP Endpoint
Update name, inbound agent, or active state. The slug is immutable — delete and recreate if you need a different URI.
curl --request PATCH \
--url https://api.goyappr.com/sip-endpoints/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"inbound_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_active": true,
"allowed_source_ips": [
"<string>"
]
}
'import requests
url = "https://api.goyappr.com/sip-endpoints/{id}"
payload = {
"name": "<string>",
"inbound_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_active": True,
"allowed_source_ips": ["<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({
name: '<string>',
inbound_agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
is_active: true,
allowed_source_ips: ['<string>']
})
};
fetch('https://api.goyappr.com/sip-endpoints/{id}', 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.goyappr.com/sip-endpoints/{id}",
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([
'name' => '<string>',
'inbound_agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'is_active' => true,
'allowed_source_ips' => [
'<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.goyappr.com/sip-endpoints/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"inbound_agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"is_active\": true,\n \"allowed_source_ips\": [\n \"<string>\"\n ]\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.goyappr.com/sip-endpoints/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"inbound_agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"is_active\": true,\n \"allowed_source_ips\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.goyappr.com/sip-endpoints/{id}")
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 \"name\": \"<string>\",\n \"inbound_agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"is_active\": true,\n \"allowed_source_ips\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "After-hours",
"slug": "after-hours-bz3r3mtypuwuw8tpdw3x392s",
"inbound_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_active": true,
"last_call_at": "2023-11-07T05:31:56Z",
"allowed_source_ips": [
"203.0.113.0/24"
],
"sip_uri": "sip:after-hours-bz3r3mtypuwuw8tpdw3x392s@yappr-byoc.sip.telnyx.com",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}is_active to
temporarily disable an endpoint without deleting it — calls dialing the
slug while inactive get rejected pre-answer with endpoint_inactive.
The slug is immutable. To use a different URI, delete and recreate.Authorizations
Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.
Path Parameters
Body
Response
SIP endpoint updated
A BYOC SIP endpoint. Customers paste the returned sip_uri into their
own telephony system — calls dialed to that URI are routed to the
Yappr agent identified by inbound_agent_id. No authentication is
required at the SIP layer; the slug embedded in the URI is the
bearer credential.
Security model: the slug includes ~120 bits of entropy in its random suffix, so guessing is intractable. Treat the full URI like an API key — anyone with it can dial the agent. To revoke access, delete the endpoint (which makes the URI immediately return 404) and create a new one.
Optional defense in depth: set allowed_source_ips to restrict which
source IPs (or CIDRs) can reach the endpoint. Calls from any other
source are rejected pre-answer.
Show child attributes
Show child attributes