# Fans

> Reference generated from the OpenAPI contract: Fans.

URL : https://docs.fanconvert.ai/en/api/reference/fans

{/* Généré par scripts/generer-reference.mjs depuis openapi/public-v1.json : ne pas modifier à la main. */}

## Les étiquettes de fans d'une créatrice [#les-étiquettes-de-fans-dune-créatrice]

`GET /public/v1/creators/{creator_id}/labels` · `listFanLabels`

### Parameters [#parameters]

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `creator_id` | path | string | yes | Identifiant de la créatrice. |
| `platform` | query | "mym" \| "telegram" | no | La plateforme du fan. (default : `mym`) |

### Response 200 [#response-200]

**`Page_FanLabel_`**

| Field | Type | Required | Description |
|---|---|---|---|
| `items` | FanLabel[] | yes |  |
| `nextCursor` | string \| null | no | À repasser en `cursor` pour lire la page suivante ; null = dernière page. |

**`FanLabel`**

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | string | yes |  |
| `name` | string | yes |  |
| `color` | string | yes |  |

### Possible errors [#possible-errors]

`401` · `403` · `404` · `422` · `429` · `503` — Error format: [Errors](/en/api/rest/erreurs).

### Example [#example]

```bash
curl -X GET "https://app.fanconvert.ai/public/v1/creators/{creator_id}/labels" \
  -H "Authorization: Bearer $FANCONVERT_API_KEY"
```

## La fiche d'un fan : étiquettes et note de l'équipe [#la-fiche-dun-fan--étiquettes-et-note-de-léquipe]

`GET /public/v1/creators/{creator_id}/fans/{conversation_id}` · `getFan`

### Parameters [#parameters-1]

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `creator_id` | path | string | yes | Identifiant de la créatrice. |
| `conversation_id` | path | string | yes | Identifiant de la conversation. |
| `platform` | query | "mym" \| "telegram" | no | La plateforme du fan. (default : `mym`) |

### Response 200 [#response-200-1]

**`FanCard`**

| Field | Type | Required | Description |
|---|---|---|---|
| `conversationId` | string | yes |  |
| `platform` | "mym" \| "telegram" | yes |  |
| `labels` | FanLabel[] | yes |  |
| `note` | TeamNote | yes |  |

**`FanLabel`**

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | string | yes |  |
| `name` | string | yes |  |
| `color` | string | yes |  |

**`TeamNote`**

| Field | Type | Required | Description |
|---|---|---|---|
| `text` | string \| null | yes |  |
| `revision` | integer | yes | À renvoyer en `expectedRevision` pour écrire. |
| `updatedAt` | string (date-time) \| null | yes |  |

### Possible errors [#possible-errors-1]

`401` · `403` · `404` · `422` · `429` · `503` — Error format: [Errors](/en/api/rest/erreurs).

### Example [#example-1]

```bash
curl -X GET "https://app.fanconvert.ai/public/v1/creators/{creator_id}/fans/{conversation_id}" \
  -H "Authorization: Bearer $FANCONVERT_API_KEY"
```

## Écrire la note de l'équipe sur un fan [#écrire-la-note-de-léquipe-sur-un-fan]

`PUT /public/v1/creators/{creator_id}/fans/{conversation_id}/note` · `putFanNote`

### Parameters [#parameters-2]

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `creator_id` | path | string | yes | Identifiant de la créatrice. |
| `conversation_id` | path | string | yes | Identifiant de la conversation. |
| `platform` | query | "mym" \| "telegram" | no | La plateforme du fan. (default : `mym`) |

### Request body [#request-body]

**`TeamNoteWrite`**

| Field | Type | Required | Description |
|---|---|---|---|
| `text` | string | yes | La note, 1 000 caractères au plus ; vide = retirée. |
| `expectedRevision` | integer | yes | La `revision` lue : une autre écriture entre-temps → 409. |

### Response 200 [#response-200-2]

**`FanCard`**

| Field | Type | Required | Description |
|---|---|---|---|
| `conversationId` | string | yes |  |
| `platform` | "mym" \| "telegram" | yes |  |
| `labels` | FanLabel[] | yes |  |
| `note` | TeamNote | yes |  |

**`FanLabel`**

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | string | yes |  |
| `name` | string | yes |  |
| `color` | string | yes |  |

**`TeamNote`**

| Field | Type | Required | Description |
|---|---|---|---|
| `text` | string \| null | yes |  |
| `revision` | integer | yes | À renvoyer en `expectedRevision` pour écrire. |
| `updatedAt` | string (date-time) \| null | yes |  |

### Possible errors [#possible-errors-2]

`401` · `403` · `404` · `409` · `422` · `429` · `503` — Error format: [Errors](/en/api/rest/erreurs).

### Example [#example-2]

```bash
curl -X PUT "https://app.fanconvert.ai/public/v1/creators/{creator_id}/fans/{conversation_id}/note" \
  -H "Authorization: Bearer $FANCONVERT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'
```

## Poser une étiquette sur un fan (sans effet si elle y est déjà) [#poser-une-étiquette-sur-un-fan-sans-effet-si-elle-y-est-déjà]

`PUT /public/v1/creators/{creator_id}/fans/{conversation_id}/labels/{label_id}` · `addFanLabel`

### Parameters [#parameters-3]

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `creator_id` | path | string | yes | Identifiant de la créatrice. |
| `conversation_id` | path | string | yes | Identifiant de la conversation. |
| `label_id` | path | string | yes | Identifiant de l'étiquette. |
| `platform` | query | "mym" \| "telegram" | no | La plateforme du fan. (default : `mym`) |

### Response 200 [#response-200-3]

**`FanCard`**

| Field | Type | Required | Description |
|---|---|---|---|
| `conversationId` | string | yes |  |
| `platform` | "mym" \| "telegram" | yes |  |
| `labels` | FanLabel[] | yes |  |
| `note` | TeamNote | yes |  |

**`FanLabel`**

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | string | yes |  |
| `name` | string | yes |  |
| `color` | string | yes |  |

**`TeamNote`**

| Field | Type | Required | Description |
|---|---|---|---|
| `text` | string \| null | yes |  |
| `revision` | integer | yes | À renvoyer en `expectedRevision` pour écrire. |
| `updatedAt` | string (date-time) \| null | yes |  |

### Possible errors [#possible-errors-3]

`401` · `403` · `404` · `409` · `422` · `429` · `503` — Error format: [Errors](/en/api/rest/erreurs).

### Example [#example-3]

```bash
curl -X PUT "https://app.fanconvert.ai/public/v1/creators/{creator_id}/fans/{conversation_id}/labels/{label_id}" \
  -H "Authorization: Bearer $FANCONVERT_API_KEY"
```

## Retirer une étiquette d'un fan [#retirer-une-étiquette-dun-fan]

`DELETE /public/v1/creators/{creator_id}/fans/{conversation_id}/labels/{label_id}` · `removeFanLabel`

### Parameters [#parameters-4]

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `creator_id` | path | string | yes | Identifiant de la créatrice. |
| `conversation_id` | path | string | yes | Identifiant de la conversation. |
| `label_id` | path | string | yes | Identifiant de l'étiquette. |
| `platform` | query | "mym" \| "telegram" | no | La plateforme du fan. (default : `mym`) |

### Response 200 [#response-200-4]

**`FanCard`**

| Field | Type | Required | Description |
|---|---|---|---|
| `conversationId` | string | yes |  |
| `platform` | "mym" \| "telegram" | yes |  |
| `labels` | FanLabel[] | yes |  |
| `note` | TeamNote | yes |  |

**`FanLabel`**

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | string | yes |  |
| `name` | string | yes |  |
| `color` | string | yes |  |

**`TeamNote`**

| Field | Type | Required | Description |
|---|---|---|---|
| `text` | string \| null | yes |  |
| `revision` | integer | yes | À renvoyer en `expectedRevision` pour écrire. |
| `updatedAt` | string (date-time) \| null | yes |  |

### Possible errors [#possible-errors-4]

`401` · `403` · `404` · `409` · `422` · `429` · `503` — Error format: [Errors](/en/api/rest/erreurs).

### Example [#example-4]

```bash
curl -X DELETE "https://app.fanconvert.ai/public/v1/creators/{creator_id}/fans/{conversation_id}/labels/{label_id}" \
  -H "Authorization: Bearer $FANCONVERT_API_KEY"
```