Update your SIP endpoint.

This endpoint allows you to update data about the SIP endpoint. It accepts SIP endpoint's unique ID in path and update parameters in body. In case new password was generated during the update, the response will contain a new password. Make sure to store it. The SIP endpoint unique ID can be retrieved from GET /api/v1/sip/endpoints, which returns the list of SIP endpoints assigned to the current customer.

Path Parameters

id*integer

SIP endpoint's unique ID

Range1 <= value

Header Parameters

Authorization*string

Your API token

Request Body

application/json

SIP endpoint's update parameters

auth?string

Optional parameter. It is required to update username, password or ip_acl. But changing the authentication type (from ip_acl to userpass, for example) of the endpoint is not recommended. If you want to change SIP endpoint's authentication method, we expect you to delete the old endpoint, and create new endpoint with desired values.

Value in"ip" | "userpass" | "combined"

description?string

Optional parameter. If provided, the description of SIP endpoint will be updated to given value.

ip_acl?string

Optional parameter. If you want to update ip_acl, you need to also pass auth=ip. Accepts a valid IPv4 address.

is_active?boolean

Optional parameter. If provided, the endpoint will be enabled/disabled according to given value.

name?string

Optional parameter. If provided, the name of SIP endpoint will be updated to given value.

password?string

Optional parameter. If you want to provide a new password, you can pass it here, but you also need to pass auth=userpass and a username value, to properly configure authentication. Accepts a string between 8 and 20 characters.

regenerate_password?boolean

Optional parameter. If you want to update the password, but prefer it to be generated automatically, you can pass here true alongside with username and auth=userpass. We will generate a new password and return it in response. The password will be shown only for one time in this response, so be sure to store it.

username?string

Optional parameter. If you want to update username, you need to also pass new password or regenerate_password and specify auth=userpass. Accepts a string between 3 and 64 characters. Username value must be unique across system.

Response Body

`application/json`

curl -X PATCH "https://dev-refactor-api-e.voipenv.uk/api/v1/sip/endpoints/1" \  -H "Authorization: string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "endpoint": {
    "auth": "ip",
    "created_at": "string",
    "description": "string",
    "disabled_at": "string",
    "id": 0,
    "ip_acl": "string",
    "is_active": true,
    "name": "string",
    "username": "string"
  },
  "password": "string"
}

{
  "code": 0,
  "error_details": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "message": "string",
  "request_id": "string",
  "status": "error"
}

{
  "code": 0,
  "error_details": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "message": "string",
  "request_id": "string",
  "status": "error"
}

{
  "code": 0,
  "error_details": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "message": "string",
  "request_id": "string",
  "status": "error"
}

{
  "code": 0,
  "error_details": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "message": "string",
  "request_id": "string",
  "status": "error"
}

Update your SIP endpoint.

Path Parameters

Header Parameters

Request Body

Response Body

200application/json

400application/json

403application/json

404application/json

500application/json

Contact us

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`