---
title: "SDK: labels"
description: "The labels methods of the Overlane TypeScript SDK, with their signatures. Generated from the SDK types."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.overlane.app/llms.txt
> Use this file to discover all available pages before exploring further.

# SDK: labels

{/* Generated by apps/docs/scripts/generate.mjs (SDK pages from the TypeScript types in packages/sdk). Do not edit; run `pnpm --filter @overlane/docs gen`. */}

The `labels` area has 6 methods on the client. Each takes one object of path, query and body arguments and an optional `CallOptions`, and returns a promise of the response body. A refused call rejects with `OverlaneApiError` (see the [SDK index](/sdk/)).

## labelsArchive

Archive a label; refused while issues use it

- Request: `POST` on `/v1/tenants/{tenantId}/projects/{projectId}/labels/{labelId}/archive`

```ts
labelsArchive(args: { tenantId: string; projectId: string; labelId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Label>
```

## labelsCreate

Create a label

- Request: `POST` on `/v1/tenants/{tenantId}/projects/{projectId}/labels`

```ts
labelsCreate(args: { tenantId: string; projectId: string; body: CreateLabelRequest }, options?: CallOptions): Promise<Label>
```

## labelsDelete

Delete a label: it is archived and can be restored for 30 days, then removed; refused while issues use it

- Request: `DELETE` on `/v1/tenants/{tenantId}/projects/{projectId}/labels/{labelId}`

```ts
labelsDelete(args: { tenantId: string; projectId: string; labelId: string }, options?: CallOptions): Promise<Label>
```

## labelsList

List labels; archived=true lists the archived ones that can still be restored

- Request: `GET` on `/v1/tenants/{tenantId}/projects/{projectId}/labels`

```ts
labelsList(args: { tenantId: string; projectId: string; query?: { archived?: string } }, options?: CallOptions): Promise<LabelList>
```

## labelsRestore

Restore an archived label within 30 days

- Request: `POST` on `/v1/tenants/{tenantId}/projects/{projectId}/labels/{labelId}/restore`

```ts
labelsRestore(args: { tenantId: string; projectId: string; labelId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Label>
```

## labelsUpdate

Rename a label or change its colour

- Request: `PATCH` on `/v1/tenants/{tenantId}/projects/{projectId}/labels/{labelId}`

```ts
labelsUpdate(args: { tenantId: string; projectId: string; labelId: string; body: UpdateLabelRequest }, options?: CallOptions): Promise<Label>
```

Source: https://docs.overlane.app/sdk/labels/index.mdx