Skip to main content
POST
Issue a new SIP password
Issues a username-and-password trunk a new SIP password and returns it once, in sip_password. The username stays the same. Use it when a password was lost or may have leaked. Send no body (or an empty JSON object): Yappr issues the password, so it can’t be chosen. Requires sip_endpoints:manage; in the dashboard, only workspace owners and admins can issue a new password. Limit: 10 attempts per trunk in an hour that runs from the first attempt. The limit counts attempts, not new passwords issued.
The new password is in this response only. Store it now: neither the API nor the dashboard can show it again.

What happens to calls

  • The old password stops working within seconds. Your phone system’s next call with it is refused with SIP 403 Forbidden, so enter the new password right away.
  • Calls in progress are not dropped.
  • A phone system that registers learns of the change only at its next registration refresh, and that refresh fails until the new password is in.
To switch with no gap at all, create a second trunk on the same agent, move your phone system to it, then delete the old trunk. A SIP address endpoint has no password. Its address can’t be changed either: create a new endpoint, point your phone system at its sip_uri, then delete the old one.

Errors

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

Response

The trunk, with its new password in sip_password. Store it now; it is never shown again.

data
object

The endpoint, as create and rotate-password return it. On a username-and-password trunk it carries sip_password, the only time the password is ever returned.