Skip to main content
PATCH
/
sip-endpoints
/
{id}
Update SIP endpoint
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>"
  ]
}
'
{
  "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.goyappr.com/llms.txt

Use this file to discover all available pages before exploring further.

Update name, inbound agent, or active state. Toggle 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

​
Authorization
string
header
required

Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.

Path Parameters

​
id
string<uuid>
required

Body

application/json
​
name
string
​
inbound_agent_id
string<uuid>
​
is_active
boolean
​
allowed_source_ips
string[] | null

Response

200 - application/json

SIP endpoint updated

​
data
object

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.