Update SIP endpoint
update_sip_endpointChange a Vobiz SIP endpoint's alias, password, attached application, or voice/message/video permissions; only supplied fields change and the username stays fixed.
Instructions
Change a Vobiz SIP endpoint's alias, password, attached application or voice/message/video permissions. Only the fields you pass change; the username is permanent (create a new endpoint to rename). A new password signs out every registered device until it re-registers with it. Vobiz answers 202 with no body, so the result lists the fields sent rather than the new state; read it back with get_sip_endpoint. An unknown endpoint_id raises not_found. Gated by VOBIZ_ENABLE_PROVISIONING and confirm: true.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| alias | No | New friendly name, 1-100 characters. | |
| confirm | Yes | Must be true, set only after the user explicitly approved: changing this SIP endpoint. | |
| password | No | SECRET: the endpoint's new SIP password (8+ characters; 12+ with mixed case, digits and symbols recommended). It is sent to Vobiz once and never shown again. | |
| allow_video | No | Permit video calls on this endpoint (Vobiz default false). | |
| allow_voice | No | Permit voice calls on this endpoint (Vobiz default true). | |
| endpoint_id | Yes | Numeric SIP endpoint ID (4-25 digits): endpoint_id from list_sip_endpoints or create_sip_endpoint. Unknown ids raise not_found. | |
| allow_message | No | Permit messaging on this endpoint (Vobiz default true). | |
| application_id | No | Application (app_id from list_applications) that should handle this endpoint's calls from now on; sent to Vobiz as `application`. An unknown id is rejected. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | No | True on success. On a failure the result is isError with ok: false plus `error` (kind), `message`, `retryable` and sometimes `http_status`. | |
| note | No | Present after a password change: devices must re-register. | |
| changed | No | Names of the fields sent to Vobiz (application_id appears as application). | |
| updated | No | True when the change was applied by this call. | |
| endpoint_id | No | The endpoint that was changed. | |
| http_status | No | HTTP status Vobiz answered with. |