---
name: "deletePet"
mode: "api"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.6.27" }
title: "deletePet - Delete pet."
---

## deletePet

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

### Description

Delete pet

### Parameters

`Params`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | `PetDelete` | Yes | Request parameters: id Pet ID, ownerId Home ID, dataType Business data type |

### Return Value

Type: `Promise<boolean>`

Promise that resolves to whether deletion succeeded (boolean)

### Referenced Types

##### `type` PetDelete

| Property | Type | Description |
| --- | --- | --- |
| `id` | `number` | Pet ID |
| `ownerId` | `string` | Home ID |
| `dataType` | `string` | Business data type |


### Examples

#### Request example

```typescript
import { deletePet } from '@ray-js/ray';

deletePet({
  id: 1,
  ownerId: 'xxxx',
});
```

#### Response example

```json
true
```