File: labels.md

package info (click to toggle)
thunderbird 1%3A140.5.0esr-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 4,609,180 kB
  • sloc: cpp: 7,672,739; javascript: 5,901,898; ansic: 3,898,899; python: 1,413,347; xml: 653,997; asm: 462,284; java: 180,927; sh: 113,491; makefile: 20,463; perl: 14,288; objc: 13,059; yacc: 4,583; pascal: 3,352; lex: 1,720; ruby: 1,222; exp: 762; sql: 715; awk: 580; php: 436; lisp: 430; sed: 70; csh: 10
file content (75 lines) | stat: -rw-r--r-- 1,095 bytes parent folder | download | duplicates (26) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# `labels` - [Sessions API](../README.md#sessions-api)

The `labels` methods of the sessions API allow for better organization of sessions.

## Read labels

Reads all labels of a session.

### HTTP Request

`GET /api/sessions/<token>/labels`

### Response Payload

```json
"Array<String>"
```

#### Example

**Request:**

`GET /api/sessions/afd4ecb0-c339-11e9-b66c-eca76c2bea9c/labels`

**Response:**

```json
["label1", "label2", "label3"]
```

## Update labels

Update all labels of a session.

### HTTP Request

`PUT /api/sessions/<token>/labels`

### Request Payload

```json
"Array<String>"
```

The array of labels provided in the request payload will replace all existing labels of the session.

#### Example

**Request:**

`GET /api/sessions/afd4ecb0-c339-11e9-b66c-eca76c2bea9c/labels`

**Response:**

```json
["label1", "label2", "label3"]
```

**Request:**

`PUT /api/sessions/afd4ecb0-c339-11e9-b66c-eca76c2bea9c/labels`

```json
["label4", "label5"]
```

**Request:**

`GET /api/sessions/afd4ecb0-c339-11e9-b66c-eca76c2bea9c/labels`

**Response:**

```json
["label4", "label5"]
```