Update device

Update an existing device.

When to use. Rename a device or reset its registration password.

Request body. extension (required): identifies the device to update. name (optional): a new label. reset_password (optional): set to 1 to generate a new registration password.

Shape. { "devices": [ <device> ] } for the updated device.

put/{sub_domain}/api/devices

Request

Base URL
https://api.commpeak.com/dialer
URL
https://api.commpeak.com/dialer/{sub_domain}/api/devices
Auth
API key in header Authorization

Path parameters

sub_domainstring required

Dialer Name (subdomain)

Request body

extensionstring required

Extension identifying the device to update.

namestring nullable

Device name / description.

reset_passwordinteger nullable

If set to 1, a new registration password is generated for this device.

Response

Successful Response

Example response

{
  "devices": [
    {
      "created_at": "2023-07-13 09:47:56",
      "extension": 199,
      "id": 1,
      "name": "dev-agent",
      "password": "69a9f6eddfd521fce4366c945a95cab5"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.