Skip to main content
PATCH
Update SIP endpoint
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.