## Cancel

`client.file.cancel(stringid, FileCancelParamsparams?, RequestOptionsoptions?): FileCancelResponse`

**post** `/v1/files/{id}/cancel`

Cancels a pending upload by transitioning the file to `CANCELLED`. Only files in `PENDING` status can be cancelled. **[Required scope](/using-the-api/scopes/):** `files:create`

**[Rate limit category](/using-the-api/rate-limits/):** Write

### Parameters

- `id: string`

  Unique identifier of the file to cancel.

- `params: FileCancelParams`

  - `body?: Body`

### Returns

- `FileCancelResponse`

  - `id: string`

    Unique identifier for the file.

  - `completedAt: string | null`

    When the file upload was completed.

  - `createdAt: string`

    When the file upload session was created.

  - `expiresAt: string | null`

    When the upload session expires. Null once completed, cancelled, or expired.

  - `filename: string`

    Original filename.

  - `mimeType: string`

    MIME type of the file.

  - `sizeBytes: number`

    File size in bytes.

  - `status: "PENDING" | "COMPLETED" | "CANCELLED" | "EXPIRED"`

    Current upload status of the file.

    - `"PENDING"`

    - `"COMPLETED"`

    - `"CANCELLED"`

    - `"EXPIRED"`

### Example

```typescript
import Lightfield from 'lightfield';

const client = new Lightfield({
  apiKey: 'My API Key',
});

const fileCancelResponse = await client.file.cancel('id');

console.log(fileCancelResponse.id);
```