---
name: "updateDpName"
mode: "api"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.5.2" }
title: "updateDpName - Update Device DP Name"
---

## updateDpName

> [VERSION] @ray-js/ray >= 1.5.2

### Description

Update device DP name

### Parameters

`Params`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `params` | `IUpdateDpName` | Yes | Request parameters |

### Return Value

Type: `Promise<boolean>`

Whether the update succeeded

### Referenced Types

##### `interface` IUpdateDpName

| Property | Type | Description |
| --- | --- | --- |
| `devId` | `string` | Device ID |
| `dpId` | `string` | DP ID |
| `name` | `string` | DP custom name |
| `gwId` | `string` | Gateway ID (optional) |


### Examples

#### Basic usage

```ts
import { updateDpName } from '@ray-js/ray';

updateDpName({
  devId: 'vdevo169477319679442',
  dpId: '21',
  name: 'work_mode',
}).then((res) => {
  console.log('Update result:', res);
}).catch((error) => {
  console.error(error);
});
```