Update SIP Endpoint

To update a SIP Endpoint, send your POST method request with valid parameters to the following base URL.

Base URL


Required Parameters

These are the required POST method parameters with description.

Parameter NameTypeDescription
*appidnumberYour app id
*secretstringYour app secret
*usernamestringThe name of the existing user
*passwordstringNew Password for the user
The * marked property is mandatory.

Sample JSON Request

Below is the following sample JSON POST method request to update SIP endpoint

"appid": 2222223,
"secret": "635a5e93-3e5f-4aa5-b7ab-2a04cd5es039",
"username": "YOUR_USERNAME",
"password": "YOUR_NEW_PASSWORD"

Sample JSON Response

If the provided information is valid, your web server will get a sample response from PIOPIY Platform as given below

"code": "cmi-200",
"username": "YOUR_USERNAME",
"password": "YOUR_NEW_PASSWORD",
"msg": "Updated successfully"


These are the list of properties and its description

usernamestringYour endpoint username
passwordstringYour endpoint new password

HTTP status codes

PIOPIY API platform represents the following status code to identity the errors.

Status codeStatus codeDescription
200OKWe received the request
400ErrorUsername does not exists
420ErrorInvalid app id or secret, failed to authenticate token
502ErrorMissing required property