> For the complete documentation index, see [llms.txt](https://missiveapp.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://missiveapp.com/docs/developers/fr/rest-api/endpoints.md).

# Endpoints

Référence complète des endpoints de l’API Missive : analyses, conversations, brouillons, posts, contacts, Libellés et plus encore.

## Statistiques

Les endpoints d’analytics vous permettent de récupérer un rapport basé sur une période sélectionnée et des filtres facultatifs tels que Boîte d’équipe, Utilisateurs, Libellés, etc. Deux endpoints sont impliqués en raison de la nature asynchrone de la génération des rapports : une requête pour créer le rapport et une autre pour récupérer les données peu après.

{% hint style="info" %}
Les endpoints de l’API Analytics nécessitent un abonnement Productive ou Business. Les capacités de filtrage (équipes, Utilisateurs, Libellés, Comptes) nécessitent un abonnement Business.
{% endhint %}

Exemple d’utilisation Synchronisez automatiquement les données d’analytique vers votre outil de Business Intelligence.

### Créer un rapport d’analyse

`POST /v1/analytics/reports`

{% tabs %}
{% tab title="Simple" %}
{% code title="payload de la requête" %}

```json
{
  "reports": {
    "organization": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92",
    "start": 1691812800,
    "end": 1692371867,
    "time_zone": "America/Montreal"
  }
}
```

{% endcode %}
{% endtab %}

{% tab title="Avec des filtres" %}
{% code title="payload de la requête" %}

```json
{
  "reports": {
    "organization": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92",
    "start": 1691812800,
    "end": 1692371867,
    "time_zone": "America/Montreal",
    "teams": [
      "0e24f298-965d-4475-9220-b32636a1e2c3"
    ],
    "Utilisateurs": [
      "1ce8117e-ae42-4304-b953-c81656da4bd1",
      "74f91030-39b8-4627-9835-9cfbce9d67c1"
    ],
    "Comptes": [
      "716be7a6-fd40-45a2-bfcb-43b9ed38d1f0",
      "a5d2aa1c-3828-4f90-bbd8-3dffaadda97e"
    ],
    "account_types": [
      "e-mail",
      "sms"
    ],
    "shared_labels": [
      "bca0bb8f-8b2f-45f8-a59a-333de84f0184"
    ]
  }
}
```

{% endcode %}
{% endtab %}
{% endtabs %}

{% code title="Réponse" %}

```json
{
  "reports": {
    "id": "8441d4a0-a0ad-4f0f-aa9c-1cc881057e42"
  }
}
```

{% endcode %}

Cet ID doit ensuite être inclus dans un [Demande de rapport](#get-analytics-report).

**Paramètres**

| Nom (\* obligatoire) | Description                                                                                                     | Exemple                                    |
| -------------------- | --------------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
| `organisation`\*     | Chaîne d’ID de l’Organisation                                                                                   | `"0d9bab85-a74f-4ece-9142-0f9b9f36ff92"`   |
| `Démarrer`\*         | Début de la période du rapport                                                                                  | `1691812800`                               |
| `fin`\*              | Fin de la période du rapport                                                                                    | `1692371867`                               |
| `time_zone`          | Identifiant du fuseau horaire ( [reference](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)) | `"America/Montreal"`                       |
| `teams`              | Tableau de chaînes d’identifiants d’équipe                                                                      | `["0e24f298-965d-4475-9220-b32636a1e2c3"]` |
| `utilisateurs`       | Array de chaînes d’ID utilisateur                                                                               | `["1ce8117e-ae42-4304-b953-c81656da4bd1"]` |
| `libellés_partagés`  | Tableau de chaînes d’ID de libellés d’Organisation                                                              | `["bca0bb8f-8b2f-45f8-a59a-333de84f0184"]` |
| `comptes`            | Tableau de chaînes d’ID du compte                                                                               | `["716be7a6-fd40-45a2-bfcb-43b9ed38d1f0"]` |
| `account_types`      | Tableau de type string                                                                                          | `["email", "sms"]`                         |

`équipes, Utilisateurs, Libellés partagés, Comptes`\
Consultez [ID de ressource](https://missiveapp.com/docs/developers/fr/rest-api.md#resource-ids).

`account_types`\
`« personnalisé »`, `"e-mail"`, `"Instagram"`, `"live_chat"`, `"Messenger"`, `"sms"`, `"WhatsApp"`

### Obtenir le rapport d’analyses

`GET /v1/analytics/reports/:id`

Récupérer un rapport à l’aide de son id renvoyé par une requête de création de rapport. Les données du rapport sont renvoyées en JSON.

La plupart des rapports sont prêts en 2 ou 3 secondes après leur création, mais certains peuvent prendre 30 secondes ou plus. Ils expirent 60 secondes après leur achèvement. Une réponse 404 vide est renvoyée pour les rapports incomplets, expirés ou inexistants.

{% hint style="info" %}
Récupérer un rapport 5 secondes après sa création et réessayer toutes les 5 secondes jusqu’à ce qu’une réponse 200 réussie soit renvoyée.
{% endhint %}

***

## Contacts

Les endpoints de contact vous permettent de gérer vos contacts par programmation.

Exemple d’utilisation : Synchroniser les contacts automatiquement entre Missive et votre CRM.

### Créer des contacts

`POST /v1/contacts`

{% code title="payload de la requête" %}

```json
{
  "contacts": [
    {
      "contact_book": "551b8675-11e9-49c3-aac0-01fb8510d862",
      "first_name": "Philippe",
      "last_name": "Lehoux",
      "starred": true,
      "infos": [
        {
          "kind": "phone_number",
          "label": "mobile",
          "value": "+1 518 777-7777"
        },
        {
          "kind": "email",
          "label": "home",
          "value": "philippe@missiveapp.com"
        }
      ],
      "memberships": [
        {
          "group": {
            "kind": "group",
            "name": "VIPs"
          }
        },
        {
          "title": "CEO",
          "location": "Quebec City",
          "group": {
            "kind": "Organisation",
            "name": "Missive"
          }
        }
      ]
    }
  ]
}
```

{% endcode %}

Une requête réussie renverra les contacts nouvellement créés.

{% code title="Réponse" %}

```json
{
  "contacts": [
    {
      "id": "5960dcd2-3382-4430-aa70-955a2c62040a",
      "first_name": "Philippe",
      "last_name": "Lehoux",
      "starred": true,
      "contact_book": "db3767be-f506-4bd4-9e8f-b67afa332d44",
      "deleted": false,
      "modified_at": 1556201911,
      "infos": [
        {
          "kind": "email",
          "label": "home",
          "value": "philippe@missiveapp.com"
        },
        {
          "kind": "phone_number",
          "label": "mobile",
          "value": "+1 518 777-7777"
        }
      ],
      "memberships": [
        {
          "title": "CEO",
          "location": "Québec",
          "group": {
            "id": "f8905b6f-2d13-466a-a2e6-8e3de090a6d1",
            "kind": "Organisation",
            "name": "Missive"
          }
        }
      ]
    }
  ]
}
```

{% endcode %}

**Attributs**

| Nom (\* obligatoire)   | Description                                                                                  | Exemple                                                                       |
| ---------------------- | -------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `contact_book`\*       | Chaîne d’ID du Carnet de contacts                                                            | `"551b8675-11e9-49c3-aac0-01fb8510d862"`                                      |
| `first_name`           | string                                                                                       | `"Philippe"`                                                                  |
| `last_name`            | string                                                                                       | `"Lehoux"`                                                                    |
| `middle_name`          | string                                                                                       | `"Antoine"`                                                                   |
| `phonetic_first_name`  | string                                                                                       | `"f ih l - IH - p ai"`                                                        |
| `phonetic_last_name`   | string                                                                                       | `"l ay h oo"`                                                                 |
| `phonetic_middle_name` | string                                                                                       | `"ah n t - w ah n"`                                                           |
| `préfixe`              | string                                                                                       | `"M."`                                                                        |
| `suffixe`              | string                                                                                       | `"Jr."`                                                                       |
| `surnom`               | string                                                                                       | `"Phil"`                                                                      |
| `classer_sous`         | string                                                                                       | `"Missive"`                                                                   |
| `notes`                | string                                                                                       | `"Prospect sympa !"`                                                          |
| `étoilé`               | booléen                                                                                      | `vrai`                                                                        |
| `genre`                | string                                                                                       | `"Masculin"`                                                                  |
| `infos`                | Tableau contenant des objets d’informations de contact, voir ci-dessous pour plus de détails | `[{"kind": "email", "label": "work", "value": "phil@missiveapp.com"}]`        |
| `adhésions`            | Tableau contenant des objets d’appartenance au contact, voir ci-dessous pour plus de détails | `[{ "title": "CEO", "group": { "kind": "Organisation", "name": "Missive" }}]` |

`infos`

Le `infos` array vous permet d’associer des données de différents types à un contact : `e-mail`, `twitter`, `phone_number`, `facebook`, `physical_address`, `url`, `custom`.

Infos avec kind `e-mail`

| Nom (\* obligatoire) | Description                                                                       | Exemple                     |
| -------------------- | --------------------------------------------------------------------------------- | --------------------------- |
| `kind`\*             | string                                                                            | `"e-mail"`                  |
| `value`\*            | Adresse e-mail                                                                    | `"philippe@missiveapp.com"` |
| `libellé`\*          | Type de l’Adresse e-mail. Valeurs acceptées : `home`, `work`, `personal`, `other` | `"work"`                    |
| `custom_label`       | Valeur du libellé personnalisé, à utiliser uniquement si `libellé` is `other`     | `"old"`                     |

Infos avec kind `phone_number`

| Nom (\* obligatoire) | Description                                                                                                                              | Exemple             |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
| `kind`\*             | string                                                                                                                                   | `"phone_number"`    |
| `value`\*            | Numéro de téléphone                                                                                                                      | `"+1 518 777-7777"` |
| `libellé`\*          | Type du Numéro de téléphone. Valeurs acceptées : `main`, `mobile`, `home`, `work`, `home_fax`, `work_fax`, `other_fax`, `pager`, `other` | `"mobile"`          |
| `custom_label`       | Valeur du libellé personnalisé, à utiliser uniquement si `libellé` is `other`                                                            | `"old"`             |

Infos avec kind `twitter`

| Nom (\* obligatoire) | Description                                                                   | Exemple      |
| -------------------- | ----------------------------------------------------------------------------- | ------------ |
| `kind`\*             | string                                                                        | `"twitter"`  |
| `value`\*            | Nom d’utilisateur Twitter                                                     | `"@plehoux"` |
| `libellé`\*          | Type de compte Twitter. Valeurs acceptées : `work`, `personal`, `other`       | `"personal"` |
| `custom_label`       | Valeur du libellé personnalisé, à utiliser uniquement si `libellé` is `other` | `"old"`      |

Infos avec kind `facebook`

| Nom (\* obligatoire) | Description                                                                   | Exemple                     |
| -------------------- | ----------------------------------------------------------------------------- | --------------------------- |
| `kind`\*             | string                                                                        | `"facebook"`                |
| `name`\*             | Nom d’utilisateur Facebook                                                    | `"Philippe-Antoine Lehoux"` |
| `libellé`\*          | Type de compte Facebook. Valeurs acceptées : `work`, `personal`, `other`      | `"personal"`                |
| `custom_label`       | Valeur du libellé personnalisé, à utiliser uniquement si `libellé` is `other` | `"old"`                     |

Infos avec kind `physical_address`

| Nom (\* obligatoire) | Description                                                                   | Exemple              |
| -------------------- | ----------------------------------------------------------------------------- | -------------------- |
| `kind`\*             | string                                                                        | `"physical_address"` |
| `street`             | string                                                                        | `123 Fake Street`    |
| `extended_address`   | string                                                                        | `Office 222`         |
| `city`               | string                                                                        | `Quebec`             |
| `region`             | string                                                                        | `QC`                 |
| `postal_code`        | string                                                                        | `G1K 3T4`            |
| `po_box`             | string                                                                        | `PO#12345`           |
| `country`            | string                                                                        | `Canada`             |
| `libellé`\*          | Type d’adresse. Valeurs acceptées : `work`, `home`, `other`                   | `"work"`             |
| `custom_label`       | Valeur du libellé personnalisé, à utiliser uniquement si `libellé` is `other` | `"old"`              |

Infos avec kind `url`

| Nom (\* obligatoire) | Description                                                                                     | Exemple                     |
| -------------------- | ----------------------------------------------------------------------------------------------- | --------------------------- |
| `kind`\*             | string                                                                                          | `"url"`                     |
| `value`\*            | URL                                                                                             | `"https://missiveapp.com/"` |
| `libellé`\*          | Type d’URL. Valeurs acceptées : `page d’accueil`, `profil`, `blog`, `work`, `personal`, `other` | `« page d’accueil »`        |
| `custom_label`       | Valeur du libellé personnalisé, à utiliser uniquement si `libellé` is `other`                   | `« admin »`                 |

Infos avec kind `custom`

| Nom (\* obligatoire) | Description                                                  | Exemple                        |
| -------------------- | ------------------------------------------------------------ | ------------------------------ |
| `kind`\*             | string                                                       | `« personnalisé »`             |
| `value`\*            | string                                                       | `« Une valeur personnalisée »` |
| `libellé`\*          | Type d’information personnalisé. Valeurs acceptées : `other` | `« autre »`                    |
| `custom_label`       | Valeur du libellé personnalisé                               | `« personnalisé »`             |

`adhésions`

Le `adhésions` un tableau vous permet de relier un contact à des Organisations ou à des groupes. Une appartenance intègre toujours un `groupe`, qui a un `kind` égal à l’un ou à l’autre `groupe` ou `organisation`.

* Les Organisations sont le plus souvent utilisées pour relier des contacts à leur lieu de travail.
* Les groupes servent à regrouper des contacts. Voyez les groupes comme des libellés.

| Nom (\* obligatoire) | Description                                             | Exemple                                       |
| -------------------- | ------------------------------------------------------- | --------------------------------------------- |
| `service`            | peut être défini si `groupe` est de type `organisation` | `"Finance"`                                   |
| `titre`              | peut être défini si `groupe` est de type `organisation` | `"CFO"`                                       |
| `lieu`               | peut être défini si `groupe` est de type `organisation` | `"Montréal"`                                  |
| `description`        | peut être défini si `groupe` est de type `organisation` | `"Gérer les rapports"`                        |
| `groupe`\*           | Objet, voir ci-dessous pour plus de détails             | `{"kind": "organisation", "name": "Missive"}` |

`memberships.group`

| Nom (\* obligatoire) | Description                                                  | Exemple            |
| -------------------- | ------------------------------------------------------------ | ------------------ |
| `kind`\*             | Type de groupe. Valeurs acceptées : `organisation`, `groupe` | `« Organisation »` |
| `name`\*             | string                                                       | `"Missive"`        |

**Propriétés du contact**

La même structure est renvoyée par [Créer des contacts](#create-contact-s), [Mettre à jour le(s) contact(s)](#update-contact-s), [Lister les contacts](#list-contacts), et [Obtenir un contact](#get-a-contact).

| Nom (\* toujours présent) | Description                                                                                                      |
| ------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `id`\*                    | UUID du contact                                                                                                  |
| `supprimé`\*              | Indique si le contact est supprimé                                                                               |
| `modified_at`\*           | Horodatage Unix de la dernière modification du contact                                                           |
| `contact_book`\*          | UUID du carnet de contacts                                                                                       |
| `first_name`              |                                                                                                                  |
| `last_name`               |                                                                                                                  |
| `middle_name`             |                                                                                                                  |
| `phonetic_first_name`     |                                                                                                                  |
| `phonetic_last_name`      |                                                                                                                  |
| `phonetic_middle_name`    |                                                                                                                  |
| `préfixe`                 |                                                                                                                  |
| `suffixe`                 |                                                                                                                  |
| `surnom`                  |                                                                                                                  |
| `classer_sous`            |                                                                                                                  |
| `notes`                   |                                                                                                                  |
| `étoilé`                  | Booléen                                                                                                          |
| `genre`                   |                                                                                                                  |
| `pronoms`                 |                                                                                                                  |
| `job_title`               |                                                                                                                  |
| `infos`                   | Tableau d’informations de contact (voir les types d’informations de contact dans la documentation de la requête) |
| `adhésions`               | Tableau des appartenances du contact (voir la documentation de la requête)                                       |

{% hint style="info" %}
Un contact supprimé renvoyé via `modified_since` + `include_deleted=true` ne contiendra que `id`, `deleted: true`, et `modified_at`.
{% endhint %}

### Mettre à jour le(s) contact(s)

`PATCH /v1/contacts/:id1,:id2,:id3,...`

Une requête réussie renverra les contacts mis à jour avec les éléments imbriqués `adhésions` et `infos`.

{% code title="payload de la requête" %}

```json
{
  "contacts": [
    {
      "id": "ee31f156-db95-4158-923f-b26450e0dbf7",
      "last_name": "Lehoux"
    }
  ]
}
```

{% endcode %}

**Attributs**

Contact `id` est requis. Voir la section Créer des contacts pour les autres attributs. Lors de la mise à jour d’un contact, vous pouvez ne transmettre que les attributs que vous souhaitez mettre à jour. Dans l’exemple ci-dessus, seul le nom de famille sera mis à jour.

{% hint style="warning" %}
Le `infos` et `adhésions` les tableaux sont des exceptions : lorsqu’ils sont transmis, vous devez inclure tous les éléments. Les éléments manquants seront supprimés du contact. Pour supprimer des éléments, omettez-les du tableau.
{% endhint %}

### Lister les contacts

`GET /v1/contacts`

Ce point de terminaison est utile pour synchroniser les contacts Missive vers un autre service ou pour trouver des contacts à partir d’un terme de recherche.

{% code title="Réponse" %}

```json
{
  "contacts": [
    {
      "id": "183382b8-fb70-4a35-bf22-4ebae1450553",
      "first_name": "Arthur",
      "last_name": "Sto",
      "starred": false,
      "contact_book": "487bc080-6631-4edc-830e-1d114eef4ab0",
      "deleted": false,
      "modified_at": 1556200645
    },
    {
      "id": "862aceb8-3553-4644-9300-0312a432315f",
      "first_name": "Zeb",
      "last_name": "Craft",
      "starred": false,
      "contact_book": "487bc080-6631-4edc-830e-1d114eef4ab0",
      "deleted": false,
      "modified_at": 1556200644
    },
    {
      "id": "b40713e2-e790-4c67-9eb3-22e83bd1bdf9",
      "first_name": "Alex",
      "last_name": "Alstorm",
      "starred": false,
      "contact_book": "487bc080-6631-4edc-830e-1d114eef4ab0",
      "deleted": false,
      "modified_at": 1556200643,
      "infos": [
        {
          "kind": "phone_number",
          "label": "work",
          "value": "+1 (418) 717-1066"
        },
        {
          "kind": "custom",
          "custom_label": "Favorite food",
          "value": "Pizza"
        }
      ],
      "memberships": [
        {
          "title": "Project manager",
          "group": {
            "id": "522f8e19-0261-4f8b-b8b1-8d8bb4055569",
            "kind": "Organisation",
            "name": "Pagac Inc"
          }
        }
      ]
    }
  ]
}
```

{% endcode %}

**Paramètres**

| Nom (\* obligatoire) | Par défaut  | Description                                                                                                                                                                                                                      |
| -------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `contact_book`\*     |             | ID du carnet de contacts                                                                                                                                                                                                         |
| `order`              | `last_name` | L’ordre par défaut se fait selon le nom de famille du contact. Pour obtenir les contacts mis à jour le plus récemment, transmettez `last_modified`                                                                               |
| `limit`              | `50`        | Nombre de contacts renvoyés. Valeur maximale : `200`                                                                                                                                                                             |
| `offset`             | `0`         | Décalage utilisé pour la pagination.                                                                                                                                                                                             |
| `modified_since`     | `null`      | Pour ne renvoyer que les contacts qui ont été modifiés ou créés depuis un moment donné, transmettez un temps Unix Epoch comme `1556137749`.                                                                                      |
| `include_deleted`    | `faux`      | Pour inclure les contacts supprimés dans les résultats de `modified_since` requêtes, passez `vrai`. Seuls les `id` et `supprimé` attributs du contact seront renvoyés, car les données du contact ont été supprimées de Missive. |
| `recherche`          | `null`      | Chaîne de texte pour filtrer les contacts. `recherche` le ou les termes sont comparés à toutes les informations du contact : nom, e-mail, téléphone, organisation, champs personnalisés, notes, etc.                             |

### Obtenir un contact

`GET /v1/contacts/:id`

Récupérez un contact spécifique à l’aide du contact `id`. Tenter de récupérer un contact supprimé produira une réponse 404.

***

## Carnets de contacts

Dans Missive, les contacts sont stockés dans des carnets de contacts. Les carnets de contacts peuvent être privés ou partagés avec différents membres d’une Organisation.

### Lister les carnets de contacts

`GET /v1/contact_books`

Lister les carnets de contacts auxquels l’utilisateur authentifié a accès. Rappelez-vous qu’un carnet de contacts `id` est obligatoire lors de la création d’un contact par programmation.

{% code title="Réponse" %}

```json
{
  "contact_books": [
    {
      "id": "6a012cec-c2e2-4e21-91e3-a36dba6930e7",
      "user": "0db31755-adcd-4c51-8346-66bb7194449e",
      "share_with_organization": true,
      "share_with_team": null,
      "share_with_users": [],
      "Organisation": "2b24d4f0-d082-41c7-9075-d2a34afcfcbd",
      "name": "HR",
      "description": null
    },
    {
      "id": "171ed616-bed2-4781-91b8-bf52459dd9e6",
      "user": "0db31755-adcd-4c51-8346-66bb7194449e",
      "share_with_organization": true,
      "share_with_team": null,
      "share_with_users": [],
      "Organisation": "2b24d4f0-d082-41c7-9075-d2a34afcfcbd",
      "name": "Production",
      "description": null
    },
    {
      "id": "108e216d-79f9-452c-93b9-4176213d4fdb",
      "user": "0db31755-adcd-4c51-8346-66bb7194449e",
      "share_with_organization": false,
      "share_with_team": null,
      "share_with_users": [],
      "organization": null,
      "name": "Mon livre personnel",
      "description": null
    }
  ]
}
```

{% endcode %}

**Paramètres**

| Nom (\* obligatoire) | Par défaut | Description                                                 |
| -------------------- | ---------- | ----------------------------------------------------------- |
| `limit`              | `50`       | Nombre de carnets de contacts renvoyés. Valeur max. : `200` |
| `offset`             | `0`        | Décalage utilisé pour la pagination.                        |

**Propriétés du Carnet de contacts**

| Nom (\* toujours présent)          | Description                                                                  |
| ---------------------------------- | ---------------------------------------------------------------------------- |
| `id`\*                             | UUID du carnet de contacts                                                   |
| `name`\*                           | Nom du carnet de contacts                                                    |
| `utilisateur`\*                    | UUID de l’utilisateur propriétaire                                           |
| `organisation`                     | UUID de l’Organisation pour les livres partagés                              |
| `share_with_organization`\*        | Que le livre soit partagé avec Tout le monde dans l’organisation             |
| `share_with_team`                  | UUID de l’équipe s’il est partagé avec une équipe spécifique                 |
| `partager_avec_les_utilisateurs`\* | Tableau des UUID des utilisateurs avec qui le book est explicitement partagé |
| `description`                      | Description                                                                  |
| `importation`\*                    | Si une importation est actuellement En cours                                 |
| `texte d’erreur d’importation`     | Message d’erreur de la dernière importation échouée                          |
| `import_rows_count`                | Nombre total de lignes dans l’import actuel/précédent                        |
| `import_processed_rows_count`      | Lignes traitées jusqu’à présent dans l’import actuel/la dernière importation |

***

## Groupes de contacts

Les contacts peuvent être regroupés à la fois dans des Organisations et dans des groupes. Les Organisations servent généralement à représenter un groupe de contacts liés (entreprises). Les groupes servent à regrouper des contacts sans lien entre eux ; considérez les groupes comme des Libellés.

### Lister les groupes de contacts

`GET /v1/contact_groups`

Lister les groupes de contacts ou les Organisations liés à un Carnet de contacts.

{% code title="Réponse" %}

```json
{
  "contact_groups": [
    {
      "id": "6a012cec-c2e2-4e21-91e3-a36dba6930e7",
      "name": "VIPs"
    }
  ]
}
```

{% endcode %}

**Paramètres**

| Nom (\* obligatoire) | Par défaut | Description                                                     |
| -------------------- | ---------- | --------------------------------------------------------------- |
| `contact_book`\*     |            | ID du carnet de contacts                                        |
| `kind`\*             |            | L’un ou l’autre `groupe` ou `organisation`.                     |
| `limit`              | `50`       | Nombre de groupes de contacts renvoyés. Valeur maximale : `200` |
| `offset`             | `0`        | Décalage utilisé pour la pagination.                            |

**Propriétés du groupe de contacts**

| Nom (\* toujours présent) | Description                |
| ------------------------- | -------------------------- |
| `id`\*                    | UUID du groupe de contacts |
| `name`\*                  | Nom du groupe de contacts  |

***

## Conversations

{% hint style="info" %}
**Gestion de l’état de la conversation (terminer, déplacer, assigner, etc.)**

Utiliser [Mettre à jour les conversations](#update-conversations) pour modifier l’état de la conversation sans ajouter de publication. Utiliser [Publications](#posts), [Messages](#messages), ou [Brouillons](#drafts) quand vous souhaitez aussi créer du contenu visible dans la conversation.

Les publications sont utiles pour les automatisations et les intégrations qui doivent laisser une trace visible montrant ce qui a déclenché l’action.
{% endhint %}

### Lister les conversations

`GET /v1/conversations`

Lister les conversations visibles pour l'utilisateur qui possède l'API token. Doivent être filtrées par boîte, libellé partagé ou équipe.

{% hint style="warning" %}
Au moins une boîte est requise comme filtre. En omettre toutes renvoie une `« Vous devez paginer au moins une boîte »` erreur. Passez-en un : `boîte de réception`, `tous`, `assignées`, `terminées`, `en attente`, `signalées`, `dans la corbeille`, `spam`, `brouillons`, `libellé partagé`, `team_inbox`, `team_closed`, ou `team_all`.
{% endhint %}

Renvoie les conversations triées de l’activité la plus récente à la plus ancienne. Pour paginer, passez un `jusqu’à` paramètre égal à la `last_activity_at` de la conversation la plus ancienne renvoyée dans la page précédente. La dernière page est atteinte lorsqu’un nombre de conversations inférieur à `limit` sont renvoyées ou si toutes les conversations d’une page ont la même `last_activity_at`.

{% hint style="info" %}
Une page peut renvoyer plus de conversations que `limit`. Les conversations dont l’utilisateur du API token est un invité seront renvoyées avec des données limitées, ne contenant que le `id` et `last_activity_at` Champs.
{% endhint %}

{% code title="Réponse" %}

```json
{
  "conversations": [
    {
      "id": "6d3c9b1c-7067-4a28-8ea6-ea91340b67cc",
      "created_at": 1654544954,
      "subject": null,
      "latest_message_subject": "Question?",
      "organisation": {
        "id": "96cafdc6-ec6a-4439-9b0c-f55a1133b1e7",
        "name": "Badge de conférence"
      },
      "color": null,
      "assignees": [],
      "Utilisateurs": [
        {
          "id": "dc3c4104-eced-4206-b532-ef84b331778a",
          "name": "Chad Zemlak",
          "email": "chad@conferencebade.com",
          "unassigned": false,
          "closed": false,
          "archived": false,
          "trashed": false,
          "junked": false,
          "assigned": false,
          "flagged": true,
          "snoozed": false
        }
      ],
      "attachments_count": 0,
      "messages_count": 1,
      "authors": [
        {
          "name": "Samwise Gamgee",
          "address": "sam@fellowship.org"
        }
      ],
      "drafts_count": 0,
      "send_later_messages_count": 0,
      "tasks_count": 0,
      "completed_tasks_count": 0,
      "web_url": "https://mail.missiveapp.com/#inbox/conversations/6d3c9b1c-7067-4a28-8ea6-ea91340b67cc",
      "app_url": "missive://mail.missiveapp.com/#inbox/conversations/6d3c9b1c-7067-4a28-8ea6-ea91340b67cc",
      "assignee_names": "",
      "assignee_emails": "",
      "shared_label_names": "",
      "last_activity_at": 1654544954,
      "team": {
        "id": "f36b7570-078e-408e-9cb8-2b4441ad93c0",
        "name": "Team 1",
        "organisation": "96cafdc6-ec6a-4439-9b0c-f55a1133b1e7",
        "active_members": ["dc3c4104-eced-4206-b532-ef84b331778a"],
        "observers": []
      },
      "shared_labels": []
    }
  ]
}
```

{% endcode %}

**Paramètres**

| Nom                    | Description                                                                                                                                                                                                                                                                                        |
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `limit`                | Nombre de conversations renvoyées. Par défaut : `25`. Max : `50`.                                                                                                                                                                                                                                  |
| `jusqu’à`              | Valeur d’horodatage en temps Unix utilisée pour la pagination. Utilisez le `last_activity_at` de la conversation la plus ancienne de la page précédente.                                                                                                                                           |
| `boîte de réception`   | Passer `vrai` pour lister les conversations dans la boîte de réception.                                                                                                                                                                                                                            |
| `tous`                 | Passer `vrai` pour lister les conversations dans la boîte Tous.                                                                                                                                                                                                                                    |
| `assignées`            | Passer `vrai` pour lister les conversations assignées à l’utilisateur.                                                                                                                                                                                                                             |
| `terminées`            | Passer `vrai` pour lister les conversations dans la boîte Terminées.                                                                                                                                                                                                                               |
| `en attente`           | Passer `vrai` pour lister les conversations dans la boîte En attente.                                                                                                                                                                                                                              |
| `signalées`            | Passer `vrai` pour lister les conversations dans la boîte Suivis.                                                                                                                                                                                                                                  |
| `dans la corbeille`    | Passer `vrai` pour lister les conversations dans la Corbeille.                                                                                                                                                                                                                                     |
| `spam`                 | Passer `vrai` pour lister les conversations dans le spam. Remarque : Missive utilise « spam » dans l’interface, bien que certains fournisseurs d’e-mail appellent cela « Junk ».                                                                                                                   |
| `brouillons`           | Passer `vrai` pour lister les conversations dans les Brouillons.                                                                                                                                                                                                                                   |
| `libellé partagé`      | ID du libellé partagé. Liste les conversations du libellé partagé.                                                                                                                                                                                                                                 |
| `team_inbox`           | ID de l’équipe. Liste les conversations de la boîte d’équipe.                                                                                                                                                                                                                                      |
| `team_closed`          | ID de l’équipe. Liste les conversations de la boîte Terminées de l’équipe.                                                                                                                                                                                                                         |
| `team_all`             | ID de l’équipe. Liste les conversations de la boîte Tous de l’équipe.                                                                                                                                                                                                                              |
| `organisation`         | ID de l’Organisation. Filtre les conversations pour n’afficher que celles partagées avec l’Organisation. Il n’y a aucune utilité pour le `organisation` param lors du passage d’un `libellé partagé` ou `team_` param.                                                                             |
| `e-mail`               | Chaîne d’Adresse e-mail. Filtre les conversations par une Adresse e-mail de contact précise (par ex., `user@example.com`Correspond à l’adresse dans le `De`, `À`, `Cc`, `Cci` et `Reply-To` headers. Mutuellement exclusif avec `domaine` et `contact_organization`.                               |
| `domaine`              | Chaîne de domaine. Filtrez les conversations par des contacts provenant d’un domaine e-mail spécifique (par exemple, `example.com` non `@example.com`). Correspond au domaine dans le `De`, `À`, `Cc`, `Cci` et `Reply-To` headers. Mutuellement exclusif avec `e-mail` et `contact_organization`. |
| `contact_organization` | UUID de l’organisation ou du groupe de contacts. Filtrez les conversations par les contacts appartenant à une organisation de contacts ou à un groupe de contacts spécifique. Mutuellement exclusif avec `e-mail` et `domaine`.                                                                    |

{% hint style="warning" %}
Le `e-mail`, `domaine`, et `contact_organization` Les paramètres sont mutuellement exclusifs. Vous ne pouvez utiliser qu’un seul de ces filtres de contact à la fois. En en passant plusieurs, vous obtiendrez une erreur 400.
{% endhint %}

### Récupérer une conversation

`GET /v1/conversations/:id`

Récupérer une conversation spécifique à l’aide de la conversation `id`.

{% hint style="info" %}
La conversation renvoyée peut avoir un `id`. Cela se produit lorsque les conversations sont fusionnées ; passer une ancienne conversation `id` continuera de fonctionner, mais la nouvelle conversation `id` sera renvoyée.
{% endhint %}

{% code title="Réponse" %}

```json
{
  "conversations": [
    {
      "id": "6d3c9b1c-7067-4a28-8ea6-ea91340b67cc",
      "subject": null,
      "latest_message_subject": "Question?",
      "organisation": {
        "id": "96cafdc6-ec6a-4439-9b0c-f55a1133b1e7",
        "name": "Badge de conférence"
      },
      "color": null,
      "assignees": [],
      "Utilisateurs": [
        {
          "id": "dc3c4104-eced-4206-b532-ef84b331778a",
          "name": "Chad Zemlak",
          "email": "chad@conferencebade.com",
          "unassigned": false,
          "closed": false,
          "archived": false,
          "trashed": false,
          "junked": false,
          "assigned": false,
          "flagged": true,
          "snoozed": false
        }
      ],
      "attachments_count": 0,
      "messages_count": 1,
      "authors": [
        {
          "name": "Samwise Gamgee",
          "address": "sam@fellowship.org"
        }
      ],
      "drafts_count": 0,
      "send_later_messages_count": 0,
      "tasks_count": 0,
      "completed_tasks_count": 0,
      "web_url": "https://mail.missiveapp.com/#inbox/conversations/6d3c9b1c-7067-4a28-8ea6-ea91340b67cc",
      "app_url": "missive://mail.missiveapp.com/#inbox/conversations/6d3c9b1c-7067-4a28-8ea6-ea91340b67cc",
      "assignee_names": "",
      "assignee_emails": "",
      "shared_label_names": "",
      "last_activity_at": 1654544954,
      "team": {
        "id": "f36b7570-078e-408e-9cb8-2b4441ad93c0",
        "name": "Team 1",
        "organisation": "96cafdc6-ec6a-4439-9b0c-f55a1133b1e7",
        "active_members": ["dc3c4104-eced-4206-b532-ef84b331778a"],
        "observers": []
      },
      "shared_labels": []
    }
  ]
}
```

{% endcode %}

**Propriétés de la conversation**

La même structure est renvoyée par [Lister les conversations](#list-conversations), [Récupérer une conversation](#get-a-conversation), [Mettre à jour les conversations](#update-conversations), et [Fusionner les conversations](#merge-conversations).

| Nom (\* toujours présent)     | Description                                                                                    |
| ----------------------------- | ---------------------------------------------------------------------------------------------- |
| `id`\*                        | UUID de la conversation                                                                        |
| `created_at`\*                | Horodatage Unix de la création de la conversation                                              |
| `subject`                     | Objet de la conversation                                                                       |
| `latest_message_subject`      | Objet du dernier message de la conversation                                                    |
| `organisation`                | Objet Organisation (`id`, `name`)                                                              |
| `color`                       | Couleur HEX ou nom de couleur (`good`, `warning`, `danger`)                                    |
| `authors`\*                   | Tableau des auteurs des messages (`name`, `address`)                                           |
| `external_authors`\*          | Sous-ensemble de `authors` à l’exclusion des collègues                                         |
| `utilisateurs`\*              | Tableau des utilisateurs ayant accès (voir les propriétés d’accès des utilisateurs ci-dessous) |
| `assignees`\*                 | Sous-ensemble de `utilisateurs` qui sont responsables de la conversation                       |
| `assignee_names`\*            | Noms d’affichage des responsables, séparés par des virgules                                    |
| `assignee_emails`\*           | Adresses e-mail des responsables, séparées par des virgules                                    |
| `libellés_partagés`\*         | Tableau d’objets de libellé partagé sur la conversation                                        |
| `shared_label_names`\*        | Noms des libellés partagés, séparés par des virgules                                           |
| `team`                        | Objet d’équipe compact (voir les propriétés de l’équipe compacte ci-dessous)                   |
| `messages_count`\*            | Nombre de messages dans la conversation                                                        |
| `drafts_count`\*              | Nombre de brouillons dans la conversation                                                      |
| `send_later_messages_count`\* | Nombre de messages programmés (envoi ultérieur)                                                |
| `attachments_count`\*         | Nombre de pièces jointes sur l’ensemble des messages                                           |
| `tasks_count`\*               | Nombre de tâches dans la conversation                                                          |
| `completed_tasks_count`\*     | Nombre de tâches terminées                                                                     |
| `last_activity_at`\*          | Horodatage Unix de l’activité la plus récente de la conversation                               |
| `closed_at`                   | Horodatage Unix lorsque la conversation liée à une tâche a été terminée                        |
| `web_url`\*                   | URL pour ouvrir la conversation dans l’application web                                         |
| `app_url`\*                   | URL pour ouvrir la conversation dans l’application de bureau                                   |

{% hint style="info" %}
Lorsque l’utilisateur de l’API token est un invité dans la conversation, seules `id` et `last_activity_at` sont renvoyées.
{% endhint %}

**Propriétés compactes de l’équipe**

Le `team` L’objet intégré dans les réponses de conversation est un objet équipe compact. Pour la structure complète de l’équipe, utilisez [Lister les équipes](#list-teams), [Créer des équipe(s)](#create-team-s), ou [Mettre à jour des équipe(s)](#update-team-s).

| Nom (\* toujours présent) | Description                                                           |
| ------------------------- | --------------------------------------------------------------------- |
| `id`\*                    | UUID de l’équipe                                                      |
| `name`\*                  | Nom de l’équipe                                                       |
| `organisation`\*          | UUID de l’Organisation                                                |
| `active_members`\*        | Tableau des UUID des utilisateurs pour les membres actifs de l’équipe |
| `observers`\*             | Tableau des UUID des utilisateurs pour les observateurs de l’équipe   |

**Propriétés d’accès de l’utilisateur**

Éléments à l’intérieur `utilisateurs` et `assignees` sur une conversation.

| Nom (\* toujours présent) | Description                                                                                 |
| ------------------------- | ------------------------------------------------------------------------------------------- |
| `id`\*                    | UUID de l’utilisateur                                                                       |
| `name`\*                  | Nom affiché de l’utilisateur                                                                |
| `e-mail`\*                | E-mail de l’utilisateur                                                                     |
| `assignées`\*             | Indique si l’utilisateur est Assignée à la conversation                                     |
| `non assigné`\*           | Indique si la conversation se trouve dans la boîte Non assigné de l’utilisateur             |
| `terminées`\*             | Indique si la conversation se trouve dans la boîte Terminée de l’utilisateur                |
| `archivé`\*               | Indique si la conversation est archivée pour l’utilisateur (pas dans la boîte de réception) |
| `signalées`\*             | Indique si la conversation est marquée d’une étoile (signalée) pour l’utilisateur           |
| `en attente`\*            | Indique si la conversation est en attente pour l’utilisateur                                |
| `dans la corbeille`\*     | Indique si la conversation se trouve dans la Corbeille de l’utilisateur                     |
| `spam`\*                  | Indique si la conversation se trouve dans la boîte Spam de l’utilisateur                    |

### Mettre à jour les conversations

`PATCH /v1/conversations/:id`

Met à jour une ou plusieurs conversations sans créer de publication. Utilisez ce point de terminaison pour terminer, rouvrir, déplacer, assigner, ajouter un libellé, changer la couleur ou renommer des conversations en silence. Les événements système peuvent toujours apparaître dans Missive. Lorsque la mise à jour modifie des libellés partagés, les règles de changement de libellé continuent de s’exécuter.

Pour mettre à jour plusieurs conversations dans une seule requête, passez des ID séparés par des virgules :

`PATCH /v1/conversations/:id,:id2,:id3`

Le corps de la requête doit inclure un `conversations` tableau contenant exactement un objet pour chaque ID dans l’URL. Chaque objet doit inclure le correspondant `id`.

{% hint style="info" %}
Si une conversation a été fusionnée, vous pouvez accéder à l’ancienne conversation `id`. La réponse renvoie la conversation actuelle `id`. Dans les requêtes en lot, ne transmettez pas deux identifiants qui renvoient à la même conversation fusionnée.
{% endhint %}

{% code title="Demande" %}

```json
{
  "conversations": [
    {
      "id": "6d3c9b1c-7067-4a28-8ea6-ea91340b67cc",
      "subject": "Remboursement approuvé",
      "close": true,
      "add_shared_labels": ["9825718b-3407-40b8-800d-a27361c86102"],
      "organisation": "96cafdc6-ec6a-4439-9b0c-f55a1133b1e7"
    }
  ]
}
```

{% endcode %}

{% code title="Réponse" %}

```json
{
  "conversations": [
    {
      "id": "6d3c9b1c-7067-4a28-8ea6-ea91340b67cc",
      "subject": "Remboursement approuvé"
    }
  ]
}
```

{% endcode %}

La réponse utilise la même structure d’objet de conversation que celle documentée dans [Propriétés de la conversation](#conversation-properties).

**Attributs**

| Nom (\* obligatoire)              | Description                                                                 | Exemple                                    |
| --------------------------------- | --------------------------------------------------------------------------- | ------------------------------------------ |
| `id`\*                            | Chaîne d’ID de conversation. Doit correspondre à un ID transmis dans l’URL. | `"6d3c9b1c-7067-4a28-8ea6-ea91340b67cc"`   |
| `subject`                         | Sujet de la Nouvelle conversation                                           | `"Remboursement approuvé"`                 |
| `color`                           | Code couleur HEX ou `"good"` `"warning"` `"danger"` string                  | `"#000"`, `"danger"`                       |
| `conversation_color`              | Même que `color`                                                            | `"#000"`, `"danger"`                       |
| `organisation`                    | Chaîne d’ID de l’Organisation                                               | `"90beb742-27a3-44cf-95bc-7e5097167c9d"`   |
| `team`                            | Chaîne d’ID d’équipe                                                        | `"646bb7f1-2066-40be-b8f6-bacb8b3b7419"`   |
| `force_team`                      | booléen                                                                     | `faux`                                     |
| `ajouter_des_utilisateurs`        | Array de chaînes d’ID utilisateur                                           | `["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]` |
| `Ajouter des responsables`        | Array de chaînes d’ID utilisateur                                           | `["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]` |
| `remove_assignees`                | Array de chaînes d’ID utilisateur                                           | `["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]` |
| `add_shared_labels`               | Tableau de chaînes d’identifiants de libellés partagés                      | `["9825718b-3407-40b8-800d-a27361c86102"]` |
| `supprimer_les_libellés_partagés` | Tableau de chaînes d’identifiants de libellés partagés                      | `["e4aae78f-e932-40a2-9ece-ed764aa85790"]` |
| `ajouter_à_la_boîte_de_réception` | booléen                                                                     | `vrai`                                     |
| `add_to_team_inbox`               | booléen                                                                     | `vrai`                                     |
| `terminer`                        | booléen                                                                     | `vrai`                                     |
| `rouvrir`                         | booléen                                                                     | `vrai`                                     |

`organisation`

`organisation` est requis lors de l’utilisation de `ajouter_des_utilisateurs`, `Ajouter des responsables`, `remove_assignees`, ou `add_shared_labels`.

`team`

`team` modifie l’équipe de la conversation lorsque la conversation n’est pas déjà liée à une autre équipe.

`force_team`

`force_team` force une nouvelle équipe, même si la conversation est déjà dans une autre équipe.

`ajouter des responsables, supprimer des responsables`

`Ajouter des responsables` assigne des Utilisateurs à la conversation. `remove_assignees` retire les Utilisateurs des responsables de la conversation. Les deux nécessitent `organisation`, et les ID utilisateur doivent appartenir à des membres de cette organisation.

`ajouter_des_libellés_partagés, supprimer_des_libellés_partagés`

`add_shared_labels` et `supprimer_les_libellés_partagés` gérer les libellés partagés sur la conversation. Lors de l’ajout de libellés, ils doivent appartenir à `organisation` et être visible pour l’utilisateur de l’API token.

`add_to_team_inbox`

`add_to_team_inbox` déplace la conversation vers une boîte d’équipe. Lors de la fourniture `add_to_team_inbox`, le `team` Le champ est obligatoire.

`ajouter_à_la_boîte_de_réception`

`ajouter_à_la_boîte_de_réception` déplace la conversation dans la boîte de réception pour toutes les personnes ayant accès à la conversation.

`terminer`

`terminer` termine la conversation pour toutes les personnes ayant accès à la conversation.

`rouvrir`

`rouvrir` rouvre la conversation pour toutes les personnes ayant accès à la conversation.

### Lister les messages de la conversation

`GET /v1/conversations/:id/messages`

Lister les messages de la conversation passée en tant que `id`. Les messages en brouillon sont exclus.

Renvoie les messages classés du plus récent au plus ancien. Pour paginer, transmettez un `jusqu’à` paramètre égal à la `delivered_at` du message le plus ancien renvoyé dans la page précédente. La dernière page est atteinte lorsque moins de messages que `limit` sont renvoyés ou si tous les messages d’une page ont le même `delivered_at`.

{% hint style="info" %}
Une page peut renvoyer plus de messages que `limit`.
{% endhint %}

{% code title="Réponse" %}

```json
{
  "messages": [
    {
      "id": "3fa4bcf5-e57e-47a4-9422-de2cce5f802e",
      "subject": "A Message",
      "draft": false,
      "preview": "A message from Sam",
      "type": "email",
      "delivered_at": 1563806347,
      "updated_at": 1563807320,
      "created_at": 1563807320,
      "email_message_id": "<0f1ab2d8-cd90-4dd1-a861-ef7e31fb3cdd@missiveapp.com>",
      "in_reply_to": [],
      "references": [],
      "from_field": {
        "name": "Samwise Gamgee",
        "address": "sam@fellowship.org"
      },
      "to_fields": [
        {
          "name": "Phil Smith",
          "address": "phil.smith@fakemail.com"
        }
      ],
      "cc_fields": [],
      "bcc_fields": [],
      "reply_to_fields": [],
      "attachments": [
        {
          "id": "81eed561-4908-4738-9a9f-2da886b1de43",
          "filename": "inline-image.png",
          "extension": "png",
          "url": "https://...",
          "media_type": "image",
          "sub_type": "png",
          "size": 114615,
          "width": 668,
          "height": 996
        }
      ]
    }
  ]
}
```

{% endcode %}

**Paramètres**

| Nom       | Description                                                                                                                                |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `limit`   | Nombre de messages renvoyés. Par défaut : `10`. Max : `10`                                                                                 |
| `jusqu’à` | Valeur d’horodatage en temps Unix utilisée pour la pagination. Utilisez le `delivered_at` du message le plus ancien de la page précédente. |

**Propriétés du message**

La même structure est renvoyée par [Lister les messages de la conversation](#list-conversation-messages), [Lister les brouillons de conversation](#list-conversation-drafts), [Lister les messages](#list-messages), et [Obtenir un message](#get-a-message). Le `body` est inclus uniquement par [Obtenir un message](#get-a-message). Certaines clés sont spécifiques au canal (voir les notes ci-dessous).

| Nom (\* toujours présent) | Description                                                                                                                                                                          |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `id`\*                    | UUID d’entrée                                                                                                                                                                        |
| `type`\*                  | Type de message : `e-mail`, `custom_email`, `custom_text`, `custom_html`, `twilio_message`, `messenger_message`, `instagram_message`, etc.                                           |
| `aperçu`\*                | Aperçu court du corps du message                                                                                                                                                     |
| `delivered_at`\*          | Horodatage Unix lors de la livraison du message                                                                                                                                      |
| `updated_at`\*            | Horodatage Unix lors de la dernière mise à jour du message                                                                                                                           |
| `created_at`\*            | Horodatage Unix lors de la création de l’enregistrement du message dans Missive                                                                                                      |
| `from_field`\*            | Expéditeur. Canal e-mail : objet avec `name`, `address`. Autres canaux : objet avec `id`, `name`, `username`. Pour WhatsApp, voir la note sur le changement incompatible ci-dessous. |
| `to_fields`\*             | Tableau de destinataires dans la même structure que `from_field`                                                                                                                     |
| `attachments`\*           | Tableau d’objets de pièce jointe (voir les propriétés de la pièce jointe)                                                                                                            |
| `references`\*            | Tableau de `Message-ID` chaînes auxquelles ce message fait référence                                                                                                                 |
| `subject`                 | Objet de l’e-mail. Canal e-mail uniquement                                                                                                                                           |
| `cc_fields`               | Tableau de destinataires en CC. Canal e-mail uniquement                                                                                                                              |
| `bcc_fields`              | Tableau de destinataires en BCC. Canal e-mail uniquement                                                                                                                             |
| `reply_to_fields`         | Tableau de destinataires Reply-To. Canal e-mail uniquement                                                                                                                           |
| `email_message_id`        | E-mail `Message-ID` en-tête (encapsulé dans `<>`). Canal e-mail uniquement                                                                                                           |
| `in_reply_to`             | Tableau de `Message-ID` chaînes auxquelles ce message répond. Canal e-mail uniquement                                                                                                |
| `external_id`             | ID du message du fournisseur. Canaux autres que l’e-mail uniquement (SMS, Messenger, etc.)                                                                                           |
| `author`                  | Utilisateur ayant rédigé le message (pour les messages sortants)                                                                                                                     |
| `body`                    | Corps HTML du message. Renvoyé uniquement par [Obtenir un message](#get-a-message)                                                                                                   |
| `account_author`          | Ancien alias de `from_field`. Renvoyé uniquement pour les messages SMS, Messenger et Twitter                                                                                         |
| `account_recipients`      | Ancien alias de `to_fields`. Renvoyé uniquement pour les messages SMS, Messenger et Twitter                                                                                          |

{% hint style="warning" %}
**Changement incompatible pour WhatsApp**

Pour les messages WhatsApp, le `id` dans `from_field` et `to_fields` identifie les auteurs et destinataires par leur **Business-Scoped User ID (BSUID)**, l’identifiant que Meta utilise pour faire référence à un utilisateur WhatsApp au sein de votre entreprise, à la place du numéro de téléphone du contact. Par exemple, le `id` modifications de `whatsapp:+14155551234` à `whatsapp:US.13491208655302741918`.

Si votre intégration reposait sur `from_field.id` ou `to_fields[].id` étant un numéro de téléphone pour WhatsApp, mettez-le à jour pour utiliser le BSUID. Le `username` champ contient le nom d’utilisateur WhatsApp du contact lorsqu’il en a défini un, sinon il revient à son numéro de téléphone.
{% endhint %}

{% hint style="info" %}
Lorsque l’utilisateur du API token n’est pas lié au message (ni l’auteur, ni le destinataire, ni la personne qui suit), les champs sensibles tels que `body`, `aperçu`, et les listes de destinataires peuvent être masquées.
{% endhint %}

**Propriétés de la pièce jointe**

Renvoyé dans le `attachments` tableau de messages, de brouillons, de commentaires, de publications et de Réponses.

| Nom (\* toujours présent) | Description                                                    |
| ------------------------- | -------------------------------------------------------------- |
| `id`\*                    | Attachment UUID                                                |
| `filename`\*              | Original filename                                              |
| `extension`\*             | Extension du fichier (par ex. `png`, `pdf`)                    |
| `media_type`\*            | Type MIME de niveau supérieur (par ex. `image`, `application`) |
| `sub_type`\*              | Sous-type MIME (par ex. `png`, `pdf`)                          |
| `size`\*                  | Taille du fichier en octets                                    |
| `url`\*                   | URL signée pour télécharger le fichier                         |
| `width`                   | Largeur de l’image en pixels                                   |
| `height`                  | Hauteur de l’image en pixels                                   |

### Lister les commentaires de la conversation

`GET /v1/conversations/:id/comments`

Lister les commentaires dans la conversation passée en `id`.

Renvoie les commentaires triés du plus récent au plus ancien. Pour paginer, passez un `jusqu’à` paramètre égal à la `created_at` du commentaire le plus ancien renvoyé dans la page précédente. La dernière page est atteinte lorsqu’il y a moins de commentaires que `limit` sont renvoyés ou si tous les commentaires d’une page ont la même `created_at`.

{% hint style="info" %}
Une page peut renvoyer plus de commentaires que `limit`.
{% endhint %}

{% code title="Réponse" %}

```json
{
  "comments": [
    {
      "id": "3fa4bcf5-e57e-47a4-9422-de2cce5f802e",
      "body": "This is a comment",
      "created_at": 1563806347,
      "mentions": [
        {
          "id": "1ce8117e-ae42-4304-b953-c81656da4bd1",
          "index": 0,
          "length": 8
        }
      ],
      "author": {
        "id": "dc3c4104-eced-4206-b532-ef84b331778a",
        "name": "Chad Zemlak",
        "email": "chad@example.com",
        "avatar_url": "https://..."
      },
      "attachment": {
        "id": "81eed561-4908-4738-9a9f-2da886b1de43",
        "filename": "document.pdf",
        "extension": "pdf",
        "url": "https://...",
        "media_type": "application",
        "sub_type": "pdf",
        "size": 114615
      },
      "task": {
        "description": "Follow up with client",
        "state": "in_progress",
        "due_at": 1692371867,
        "started_at": 1691812800,
        "closed_at": null,
        "assignees": [
          {
            "id": "1ce8117e-ae42-4304-b953-c81656da4bd1",
            "name": "Phil Smith",
            "email": "phil@example.com",
            "avatar_url": "https://..."
          }
        ],
        "team": {
          "id": "0e24f298-965d-4475-9220-b32636a1e2c3",
          "name": "Support",
          "Organisation": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92"
        }
      }
    }
  ]
}
```

{% endcode %}

**Paramètres**

| Nom       | Description                                                                                                                               |
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `limit`   | Nombre de commentaires renvoyés. Valeur par défaut : `10`. Max : `10`                                                                     |
| `jusqu’à` | Valeur d’horodatage en temps Unix utilisée pour la pagination. Utilisez le `created_at` du plus ancien commentaire de la page précédente. |

**Propriétés du commentaire**

| Nom (\* toujours présent) | Description                                                                                                       |
| ------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| `id`\*                    | Identifiant unique de l’entrée de commentaire                                                                     |
| `body`\*                  | Contenu texte du commentaire                                                                                      |
| `created_at`\*            | Horodatage de création du commentaire                                                                             |
| `mentions`\*              | Tableau des mentions d’utilisateurs dans le commentaire, avec des index pour les localiser dans le texte du corps |
| `author`\*                | Utilisateur qui a créé le commentaire                                                                             |
| `pièce jointe`            | Fichier joint au commentaire                                                                                      |
| `tâche`                   | Si le commentaire est associé à une tâche, l’objet tâche complet (voir [Tâches](#tasks))                          |

### Lister les brouillons de conversation

`GET /v1/conversations/:id/drafts`

Liste les messages brouillons de la conversation transmise comme `id`.

Renvoie les brouillons triés du plus récent au plus ancien. Pour paginer, transmettez un `jusqu’à` paramètre égal à la `delivered_at` du brouillon le plus ancien renvoyé dans la page précédente. La dernière page est atteinte lorsqu’il est renvoyé moins de brouillons que `limit` sont renvoyés ou si tous les brouillons d’une page ont le même `delivered_at`.

{% hint style="info" %}
Une page peut renvoyer plus de brouillons que `limit`.
{% endhint %}

{% code title="Réponse" %}

```json
{
  "drafts": [
    {
      "id": "3fa4bcf5-e57e-47a4-9422-de2cce5f802e",
      "subject": "Draft Message",
      "draft": true,
      "preview": "Un message en brouillon",
      "type": "email",
      "delivered_at": null,
      "updated_at": 1563807320,
      "created_at": 1563807320,
      "from_field": {
        "name": "Samwise Gamgee",
        "address": "sam@fellowship.org"
      },
      "to_fields": [
        {
          "name": "Phil Smith",
          "address": "phil.smith@fakemail.com"
        }
      ],
      "cc_fields": [],
      "bcc_fields": [],
      "reply_to_fields": [],
      "attachments": [],
      "author": {
        "id": "dc3c4104-eced-4206-b532-ef84b331778a",
        "name": "Chad Zemlak",
        "email": "chad@example.com",
        "avatar_url": "https://..."
      }
    }
  ]
}
```

{% endcode %}

**Paramètres**

| Nom       | Description                                                                                                                               |
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `limit`   | Nombre de brouillons renvoyés. Par défaut : `10`. Max : `10`                                                                              |
| `jusqu’à` | Valeur d’horodatage en temps Unix utilisée pour la pagination. Utilisez le `delivered_at` du plus ancien brouillon de la page précédente. |

### Lister les publications de la conversation

`GET /v1/conversations/:id/posts`

Liste les publications de la conversation passée en tant que `id`.

Renvoie les publications classées de la plus récente à la plus ancienne. Pour paginer, passez un `jusqu’à` paramètre égal à la `created_at` de la publication la plus ancienne renvoyée sur la page précédente. La dernière page est atteinte lorsqu’il y a moins de publications que `limit` sont renvoyées ou si toutes les publications d’une page ont le même `created_at`.

{% hint style="info" %}
Une page peut renvoyer plus de publications que `limit`.
{% endhint %}

{% code title="Réponse" %}

```json
{
  "posts": [
    {
      "id": "ee31f156-db95-4158-923f-b26450e0dbf7",
      "created_at": 1563806347,
      "username": "Missive",
      "username_icon": "https://s3.amazonaws.com/missive-assets/missive-avatar.png",
      "notification": {
        "title": "Un titre",
        "body": "Un texte"
      },
      "attachments": [
        {
          "author_name": "Philippe Lehoux",
          "author_link": "mailto:philippe@missiveapp.com",
          "author_icon": "avatar:philippe@missiveapp.com",
          "color": "#2266ED",
          "text": "Un nouveau client s’est inscrit !",
          "timestamp": 1511540318
        }
      ]
    }
  ]
}
```

{% endcode %}

**Paramètres**

| Nom       | Description                                                                                                                                       |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `limit`   | Nombre de publications renvoyées. Par défaut : `10`. Max : `10`                                                                                   |
| `jusqu’à` | Valeur d’horodatage en temps Unix utilisée pour la pagination. Utilisez le `created_at` de la publication la plus ancienne de la page précédente. |

**Propriétés de la publication**

Renvoyé par [Lister les publications de la conversation](#list-conversation-posts). Voir [Créer une publication](#create-a-post) pour connaître la signification de chaque champ.

| Nom (\* toujours présent) | Description                                                                        |
| ------------------------- | ---------------------------------------------------------------------------------- |
| `id`\*                    | UUID de l’entrée de la publication                                                 |
| `created_at`\*            | Horodatage Unix lors de la création de la publication                              |
| `username`                | Nom affiché comme auteur de la publication                                         |
| `username_icon`           | URL de l’image affichée comme avatar de l’auteur de la publication                 |
| `conversation_icon`       | URL de l’image utilisée comme icône de la conversation                             |
| `notification`            | Objet contenant `titre` et `body` utilisé pour afficher une notification           |
| `text`                    | Corps en texte brut de la publication                                              |
| `markdown`                | Corps de la publication au format Markdown                                         |
| `attachments`             | Tableau d’objets de pièces jointes (blocs formatés ou fichiers)                    |
| `from_field`              | Objet contenant `name`, `address`, ou `phone_number` pour la recherche de l’auteur |
| `references`              | Tableau de chaînes de référence de message                                         |

### Fusionner les conversations

`POST /v1/conversations/:id/merge`

Fusionnez la conversation passée en `:id` dans la conversation passée en `target`. Après la fusion, la conversation source (`:id`) est marquée comme remplacée et tous ses messages, commentaires et autres entrées font partie de la conversation cible.

{% hint style="info" %}
Lorsque les conversations sont permutées pendant la fusion (par ex., lorsqu’une conversation d’organisation est fusionnée dans une conversation privée, ou lorsque la source comporte nettement plus d’entrées), la conversation renvoyée `id` peut différer de celle passée en `target`.
{% endhint %}

{% code title="Demande" %}

```json
{
  "target": "3fa4bcf5-e57e-47a4-9422-de2cce5f802e",
  "subject": "Nouvel objet facultatif"
}
```

{% endcode %}

{% code title="Réponse" %}

```json
{
  "conversations": [
    {
      "id": "6d3c9b1c-7067-4a28-8ea6-ea91340b67cc",
      "created_at": 1654544954,
      "subject": "Nouveau sujet facultatif",
      "latest_message_subject": "Question?",
      "organisation": {
        "id": "96cafdc6-ec6a-4439-9b0c-f55a1133b1e7",
        "name": "Badge de conférence"
      },
      "color": null,
      "assignees": [],
      "Utilisateurs": [
        {
          "id": "dc3c4104-eced-4206-b532-ef84b331778a",
          "name": "Chad Zemlak",
          "email": "chad@conferencebade.com",
          "unassigned": false,
          "closed": false,
          "archived": false,
          "trashed": false,
          "junked": false,
          "assigned": false,
          "flagged": true,
          "snoozed": false
        }
      ],
      "attachments_count": 0,
      "messages_count": 2,
      "authors": [
        {
          "name": "Samwise Gamgee",
          "address": "sam@fellowship.org"
        }
      ],
      "drafts_count": 0,
      "send_later_messages_count": 0,
      "tasks_count": 0,
      "completed_tasks_count": 0,
      "web_url": "https://mail.missiveapp.com/#inbox/conversations/6d3c9b1c-7067-4a28-8ea6-ea91340b67cc",
      "app_url": "missive://mail.missiveapp.com/#inbox/conversations/6d3c9b1c-7067-4a28-8ea6-ea91340b67cc",
      "assignee_names": "",
      "assignee_emails": "",
      "shared_label_names": "",
      "last_activity_at": 1654544954,
      "team": null,
      "shared_labels": []
    }
  ]
}
```

{% endcode %}

**Paramètres**

| Nom \* requis | Description                                                       |
| ------------- | ----------------------------------------------------------------- |
| `target`\*    | UUID de la conversation de destination (celle qui est conservée). |
| `subject`     | Nouveau sujet pour la conversation fusionnée.                     |

L’UUID de la conversation source est transmis dans l’URL sous la forme de `:id`.

***

## Brouillons

L’endpoint drafts vous permet de créer des brouillons d’e-mail, de SMS, de WhatsApp et de Live Chat Missive, qui peuvent soit être envoyés immédiatement, soit être modifiés puis envoyés depuis l’application Missive. Vous pouvez créer des brouillons dans une nouvelle conversation ou les ajouter comme réponse à une conversation existante.

{% hint style="info" %}
**C’est l’endpoint à utiliser pour envoyer des e-mails.** Pour envoyer immédiatement, incluez `send: true` dans votre requête. Pour répondre à une conversation existante, utilisez les `conversation` ou `references` paramètres.
{% endhint %}

{% hint style="info" %}
**Exemple d’utilisation :** Créez un nouveau brouillon dans un libellé partagé nommé « Follow up » avec un corps spécifique chaque fois que quelqu’un remplit un formulaire sur votre site Web.
{% endhint %}

### Créer un brouillon

`POST /v1/drafts`

{% code title="payload de la requête" %}

```json
{
  "drafts": {
    "subject": "Bonjour",
    "body": "Monde !",
    "to_fields": [
      {
        "address": "paul@acme.com"
      }
    ],
    "from_field": {
      "name": "Philippe Lehoux",
      "address": "philippe@missiveapp.com"
    }
  }
}
```

{% endcode %}

**Attributs**

| Nom (\* obligatoire)                                                     | Description                                                                                                                                                                                                                                                                                                                                                                 | Exemple                                                                 |
| ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| `subject`                                                                | string                                                                                                                                                                                                                                                                                                                                                                      | `"Bonjour"`                                                             |
| `body`                                                                   | Chaîne HTML ou texte                                                                                                                                                                                                                                                                                                                                                        | `"<b>Monde !</b>"`                                                      |
| `quote_previous_message`                                                 | booléen                                                                                                                                                                                                                                                                                                                                                                     | `faux`                                                                  |
| `add_default_signature`                                                  | booléen                                                                                                                                                                                                                                                                                                                                                                     | `faux`                                                                  |
| `from_field` E-mail                                                      | Objet contenant `"address"` et `"name"` clés.                                                                                                                                                                                                                                                                                                                               | `{"address": "philippe@missiveapp.com", "name": "Philippe Lehoux"}`     |
| `from_field` SMS et WhatsApp                                             | Objet contenant `"phone_number"` clé, elle doit correspondre à un numéro de compte auquel vous avez accès, au format `"+"` suivi uniquement de chiffres. Une clé facultative `"type"` clé avec des valeurs de `"signalwire"`, `"twilio"`, `"twilio_whatsapp"` ou `"WhatsApp"` doit être fourni lorsque le numéro de téléphone correspond à des comptes de types différents. | `{"phone_number": "+18005550199", "type": "whatsapp"}`                  |
| `from_field` Canal personnalisé                                          | Objet contenant `"id"`, `"username"` et `"name"` clés.                                                                                                                                                                                                                                                                                                                      | `{"id": "12345", "username": "@missiveapp", "name": "Missive"}`         |
| `to_fields` E-mail                                                       | Tableau d’objets. Objet avec `"address"` et `"name"` clés.                                                                                                                                                                                                                                                                                                                  | `[{"address": "philippe@missiveapp.com", "name": "Philippe Lehoux"}]`   |
| `to_fields` SMS et WhatsApp                                              | Tableau d’objets. Objet avec `"phone_number"` clé, un seul élément est autorisé et il doit être au format `"+"` suivi uniquement de chiffres.                                                                                                                                                                                                                               | `[{"phone_number": "+18005550199"}]`                                    |
| `to_fields` Messenger et Instagram                                       | Tableau d’objets. Objet avec la `"id"` clé.                                                                                                                                                                                                                                                                                                                                 | `[{"id": "1736313053102918"}]`                                          |
| `to_fields` Canal personnalisé                                           | Tableau d’objets. Objet avec `"id"`, `"username"` et `"name"` clés.                                                                                                                                                                                                                                                                                                         | `[{"id": "12345", "username": "@missiveapp", "name": "Missive"}]`       |
| `to_fields` Missive Live Chat                                            | Tableau d’un objet. Objet avec `"id"`, `"username"` et `"name"` clés.                                                                                                                                                                                                                                                                                                       | `[{ id: '123', username: 'phil@acme.com', name: 'Phil [Unverified]' }]` |
| `cc_fields`                                                              | Tableau d’objets avec `"address"` et `"name"` clés.                                                                                                                                                                                                                                                                                                                         | `[{"address": "philippe@missiveapp.com", "name": "Philippe Lehoux"}]`   |
| `bcc_fields`                                                             | Tableau d’objets avec `"address"` et `"name"` clés.                                                                                                                                                                                                                                                                                                                         | `[{"address": "philippe@missiveapp.com", "name": "Philippe Lehoux"}]`   |
| `compte` Canal personnalisé et Missive Live Chat, Messenger et Instagram | ID du compte. Vous pouvez trouver cet ID dans les paramètres du canal personnalisé, les paramètres de Missive Live Chat ou Paramètres > API > IDs des ressources.                                                                                                                                                                                                           | `"fbf74c47-d0a0-4d77-bf3c-2118025d8102"`                                |
| `attachments`                                                            | Tableau contenant des fichiers, voir ci-dessous pour plus de détails                                                                                                                                                                                                                                                                                                        | `[{"base64_data": "iVBORw0KGgoAAAANS…", "filename": "logo.png"}]`       |
| `references`                                                             | Tableau de chaînes pour l’ajout à une conversation existante.                                                                                                                                                                                                                                                                                                               | `["<some-reference-123>"]`                                              |
| `from_field`                                                             | Objet avec les `"phone_number"`, `"address"` ou `"name"` clés, utilisées pour faire correspondre les contacts dans la barre latérale de Missive et renseigner la ligne des auteurs dans l’aperçu de la conversation                                                                                                                                                         | `{"phone_number": "+4187249887", "name": "Paul"}`                       |
| `conversation`                                                           | Chaîne d’ID de conversation pour l’ajouter à une conversation existante                                                                                                                                                                                                                                                                                                     | `"5bb24363-69e5-48ed-80a9-feee988bc953"`                                |
| `team`                                                                   | Chaîne d’ID d’équipe                                                                                                                                                                                                                                                                                                                                                        | `"646bb7f1-2066-40be-b8f6-bacb8b3b7419"`                                |
| `force_team`                                                             | booléen                                                                                                                                                                                                                                                                                                                                                                     | `faux`                                                                  |
| `organisation`                                                           | Chaîne d’ID de l’Organisation                                                                                                                                                                                                                                                                                                                                               | `"90beb742-27a3-44cf-95bc-7e5097167c9d"`                                |
| `ajouter_des_utilisateurs`                                               | Array de chaînes d’ID utilisateur                                                                                                                                                                                                                                                                                                                                           | `["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]`                              |
| `Ajouter des responsables`                                               | Array de chaînes d’ID utilisateur                                                                                                                                                                                                                                                                                                                                           | `["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]`                              |
| `remove_assignees`                                                       | Array de chaînes d’ID utilisateur                                                                                                                                                                                                                                                                                                                                           | `["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]`                              |
| `conversation_subject`                                                   | string                                                                                                                                                                                                                                                                                                                                                                      | `"Nouvel utilisateur !"`                                                |
| `conversation_color`                                                     | Code couleur HEX ou `"good"` `"warning"` `"danger"` string                                                                                                                                                                                                                                                                                                                  | `"#000"`, `"danger"`                                                    |
| `add_shared_labels`                                                      | Tableau de chaînes d’identifiants de libellés partagés                                                                                                                                                                                                                                                                                                                      | `["9825718b-3407-40b8-800d-a27361c86102"]`                              |
| `supprimer_les_libellés_partagés`                                        | Tableau de chaînes d’identifiants de libellés partagés                                                                                                                                                                                                                                                                                                                      | `["e4aae78f-e932-40a2-9ece-ed764aa85790"]`                              |
| `ajouter_à_la_boîte_de_réception`                                        | booléen                                                                                                                                                                                                                                                                                                                                                                     | `faux`                                                                  |
| `add_to_team_inbox`                                                      | booléen                                                                                                                                                                                                                                                                                                                                                                     | `faux`                                                                  |
| `terminer`                                                               | booléen                                                                                                                                                                                                                                                                                                                                                                     | `faux`                                                                  |
| `send`                                                                   | booléen                                                                                                                                                                                                                                                                                                                                                                     | `faux`                                                                  |
| `send_at`                                                                | Valeur d’horodatage en temps Unix                                                                                                                                                                                                                                                                                                                                           | `1684540565`                                                            |
| `auto_followup`                                                          | booléen, `send_at` est requis lors de la transmission de `vrai`                                                                                                                                                                                                                                                                                                             | `faux`                                                                  |
| `external_response_id` WhatsApp                                          | L’ID Twilio ou Meta du modèle que vous utilisez.                                                                                                                                                                                                                                                                                                                            | `474808552386201`                                                       |
| `external_response_variables` WhatsApp                                   | Un objet contenant les valeurs des variables du modèle que vous utilisez.                                                                                                                                                                                                                                                                                                   | `{ "1": "Philippe", "2": "This awesome project" }`                      |

`body`

Le corps HTML/texte de votre message. Les balises de paragraphe HTML ordinaires dans Missive n’afficheront pas l’espacement souhaité.

Par exemple, pour obtenir l’espacement attendu entre les paragraphes, vous modifieriez ceci :

```
<p>Paragraphe 1</p>
<p>Paragraphe 2</p>
```

à :

```
<div>Paragraphe 1</div>
<div><br></div>
<div>Paragraphe 2</div>
<div><br></div>
```

{% hint style="info" %}
**Le mode sombre est géré pour vous.** Lorsqu’un lecteur utilisant le thème sombre ouvre un e-mail mis en forme pour un fond clair, Missive génère une version sombre de votre `body`: les fonds clairs sont assombris, le texte sombre codé en dur (par exemple, noir) est éclairci pour rester lisible, et les couleurs de marque saturées sont conservées telles quelles. Les lecteurs peuvent rétablir les couleurs d’origine d’un message individuel. Vous pouvez toujours laisser les couleurs du texte non stylisées pour hériter du thème du lecteur, mais le codage en dur des couleurs ne nuit plus à la lisibilité en mode sombre.
{% endhint %}

`quote_previous_message`

Lorsque `vrai`, le brouillon inclura une version citée du dernier message de la conversation.

{% hint style="danger" %}
Soyez extrêmement prudent lorsque vous utilisez ce paramètre. Si vous créez un brouillon dans une conversation existante en utilisant `conversation` ou `references`, le contenu cité inclura le corps du message précédent. Cela pourrait potentiellement divulguer des informations sensibles si vous n’êtes pas certain du contenu du message précédent. Utilisez ce paramètre uniquement lorsque vous avez un contrôle total sur le contexte de la conversation et une visibilité complète sur celui-ci.
{% endhint %}

`add_default_signature`

Lorsque `vrai`, la signature définie pour l’alias d’envoi de l’e-mail est ajoutée au `body`, tout comme lorsque vous rédigez un brouillon dans Missive. Cela ne fonctionne que pour les e-mails, et uniquement lorsque l’ `from_field` alias dispose d’une signature.

`send`

Définissez sur `vrai` pour envoyer le brouillon immédiatement lors de sa création.

{% hint style="info" %}
**Les règles sortantes se déclenchent automatiquement.** Lorsque vous envoyez un message via l’API avec `send: true`, toute règle de message sortant correspondante s’exécutera. Cela inclut les règles avec [étapes](https://missiveapp.com/docs/advanced-features/rules/steps) qui envoient des relances, ce qui permet des séquences d’e-mails automatisées. Voir [Séquences d’e-mails automatisées](#use-case-automated-email-sequences) ci-dessous.
{% endhint %}

`send_at`

Planifiez l’envoi du brouillon à une heure ultérieure. Ne peut pas être combiné avec `send: true`.

`auto_followup`

Lorsque `auto_followup` is `vrai`, le brouillon programmé pour être envoyé plus tard avec `send_at` sera abandonné lorsqu’il y a une réponse dans la conversation.

`from_field`

`from_field` doit soit avoir un `address` qui correspond à l’un de vos alias d’e-mail dans Missive, ou un `phone_number` qui correspond à l’un de vos comptes Twilio ou SignalWire. Pour les canaux personnalisés, vous pouvez transmettre n’importe quel `id`, `username` et `name` sans restriction.

`attachments`

Le `attachments` tableau vous permet de joindre jusqu’à 25 fichiers au brouillon. La charge utile JSON totale de votre requête ne doit pas dépasser 10 Mo.

| Nom (\* obligatoire) | Description                            | Exemple                |
| -------------------- | -------------------------------------- | ---------------------- |
| `base64_data`\*      | Le contenu du fichier encodé en base64 | `"iVBORw0KGgoAAAANS…"` |
| `filename`\*         | Nom de fichier de la pièce jointe      | `"logo.png"`           |

`references`

Le `references` tableau vous permet d’ajouter un brouillon à une conversation existante. Lorsqu’une conversation existe déjà et comprend un e-mail avec un `Message-ID: <a@a.com>` ou `References: <a@a.com>` en-tête, vous pouvez ajouter `"references": ["<a@a.com>"]` à votre requête afin que le brouillon soit ajouté à cette conversation.

Si les références transmises dans la requête se rapportent à plus d’une conversation, le brouillon sera ajouté à la première conversation trouvée. Si aucune référence n’est fournie, le brouillon sera créé dans une nouvelle conversation. Si une ou plusieurs références sont fournies mais qu’aucune ne correspond à une conversation existante, le brouillon sera créé dans une nouvelle conversation.

Les chevrons autour des références sont facultatifs. Les deux `["<some-reference-123>"]` et `["some-reference-123"]` fera référence à la même conversation.

`conversation`

Si vous connaissez l’ID d’une conversation Missive existante dans laquelle vous souhaitez créer votre brouillon, vous pouvez le transmettre en tant que `conversation` au lieu d’utiliser `references`.

`subject`

Le `subject` Le champ est transmis tel quel à l’e-mail sortant. Lors de la réponse à une conversation e-mail existante, définissez toujours `subject` à `Re: [the original subject]`. Les clients e-mail comme Gmail utilisent la correspondance de l’objet pour le fil de discussion — un objet vide ou non correspondant fera apparaître la réponse comme un nouveau fil du côté du destinataire, même si elle est correctement regroupée dans Missive.

{% hint style="info" %}
Le `references` et `conversation` Les paramètres ne sont utilisés par Missive que pour localiser la bonne conversation. Ils ne contrôlent pas le e-mail sortant `References` en-tête. Une fois la conversation identifiée, Missive définit automatiquement l’ `In-Reply-To` et `References` en-têtes d’e-mail appropriés en fonction du dernier e-mail de la conversation.
{% endhint %}

`team`

`team` vous permet de lier la conversation du brouillon à une équipe. Lorsqu’une conversation est déjà liée à une équipe, ce champ est ignoré.

`force_team`

`force_team` vous permet de forcer une nouvelle équipe même si la conversation se trouve déjà dans une autre équipe.

`organisation`

`organisation` vous permet de limiter la recherche de conversations à celles déjà associées à une organisation. Si une nouvelle conversation est créée et `organisation` est transmis, la nouvelle conversation sera liée à cette organisation.

`ajouter_des_utilisateurs`

`ajouter_des_utilisateurs` détermine les utilisateurs qui auront accès à la conversation. Lors de la transmission de `ajouter_des_utilisateurs`, le `organisation` Le champ est obligatoire.

`Ajouter des responsables`

`Ajouter des responsables` vous permet d’assigner des utilisateurs à la conversation. Les responsables existants resteront assignés. Lors de la transmission de `Ajouter des responsables`, le `organisation` Le champ est obligatoire.

`remove_assignees`

`remove_assignees` vous permet de retirer des responsables de la conversation. Lors de la transmission de `remove_assignees`, le `organisation` Le champ est obligatoire.

`ajouter_des_libellés_partagés, supprimer_des_libellés_partagés`

`add_shared_labels` et `supprimer_les_libellés_partagés` vous permettent de gérer les libellés partagés appliqués à la conversation du brouillon.

`add_to_team_inbox`

`add_to_team_inbox` vous permet de déplacer la conversation du brouillon vers une boîte d’équipe. Lors de la transmission de `add_to_team_inbox`, le `team` Le champ est obligatoire.

`ajouter_à_la_boîte_de_réception`

`ajouter_à_la_boîte_de_réception` vous permet de déplacer la conversation du brouillon vers la boîte de réception pour tous ceux ayant accès à la conversation.

`terminer`

`terminer` vous permet de terminer la conversation du brouillon pour tous ceux ayant accès à la conversation.

`external_response_id, external_response_variables`

`external_response_id` et `external_response_variables` sont utilisés pour les modèles WhatsApp. Ils sont requis si vous initiez une conversation WhatsApp avec un utilisateur avec lequel vous n’avez pas déjà interagi au cours des 24 dernières heures.

`external_response_id` est l’ID Twilio ou Meta du modèle que vous utilisez. Vous pouvez les trouver soit dans le Twilio Content Template Builder soit dans WhatsApp Manager. Dans WhatsApp Manager, l’ID Meta n’apparaît pas dans la liste des modèles — il n’apparaît que dans l’URL lorsque vous ouvrez un modèle spécifique :

```
https://business.facebook.com/latest/whatsapp_manager/template_details?business_id=111111111111111&tab=template-details&childRoute=CAPI&id=2222222222222222&nav_ref=whatsapp_manager&asset_id=3333333333333333
```

La valeur après `template-details&childRoute=CAPI&id=` (p. ex. `2222222222222222`) est l’ID Meta à utiliser comme `external_response_id`.

`external_response_variables` est un objet où les clés sont les espaces réservés du modèle et les valeurs sont le contenu que vous souhaitez utiliser pour chaque espace réservé. Veillez à fournir des clés de type chaîne pour toutes les variables. Seules les variables de corps texte (`{{1}}`, `{{2}}`, etc.) sont prises en charge -- les modèles avec des en-têtes multimédias (documents, images ou autres médias définis comme un composant d’en-tête dans Meta) ne peuvent pas être envoyés via Missive.

{% hint style="warning" %}
Lorsque vous utilisez un modèle, vous devrez fournir un `body` correspondant au résultat de l’interpolation du modèle dans la charge utile du brouillon. Missive affichera la valeur du corps que vous avez fournie, mais enverra le modèle et les variables au fournisseur approprié.
{% endhint %}

### Envoyer un message

Pour envoyer un nouveau message ou une réponse, utilisez Créer un brouillon avec le `send: true` param.

{% code title="payload de la requête" %}

```json
{
  "drafts": {
    "send": true,
    "subject": "Bonjour",
    "body": "Monde !",
    "to_fields": [
      {
        "address": "paul@acme.com"
      }
    ],
    "from_field": {
      "address": "philippe@missiveapp.com"
    }
  }
}
```

{% endcode %}

### Cas d’usage : séquences d’e-mails automatisées

Combinez l’API avec [des règles de relance automatiques](https://missiveapp.com/docs/advanced-features/rules/templates/automatic-follow-ups) pour créer des campagnes automatisées déclenchées par des événements externes (p. ex. des envois de formulaires, des mises à jour de CRM).

**Fonctionnement :**

1. Créez une règle de message sortant qui se déclenche sur une phrase précise dans le corps de votre e-mail
2. Ajoutez [étapes](https://missiveapp.com/docs/advanced-features/rules/steps) à la règle. Chaque étape attend, vérifie **Non répondu** par les destinataires, puis envoie une relance avec **Envoyer une réponse**
3. Utilisez l’API pour envoyer l’e-mail initial contenant cette phrase déclencheuse
4. Les étapes envoient les e-mails de relance (p. ex. 1, 3 et 7 jours plus tard)
5. Si un destinataire répond, les prochaines relances ne sont pas envoyées

**Exemple : un formulaire de site Web déclenche une séquence d’e-mails**

{% code title="payload de la requête" %}

```json
{
  "drafts": {
    "send": true,
    "subject": "Merci de votre intérêt !",
    "body": "Bonjour ! Voici le devis que vous avez demandé…",
    "to_fields": [{ "address": "lead@example.com" }],
    "from_field": { "address": "sales@yourcompany.com" }
  }
}
```

{% endcode %}

La phrase "Here is the quote you requested" déclenche votre règle de relance, qui lance la séquence d’e-mails de relance.

### Supprimer un brouillon

`DELETE /v1/drafts/:id`

Supprime un brouillon d’une conversation. Le `:id` paramètre est l’ID du brouillon (renvoyé dans la réponse de création du brouillon).

***

## Messages

### Créer un message

`POST /v1/messages`

Créer un message entrant dans un canal personnalisé. Les canaux personnalisés permettent aux utilisateurs d’intégrer des fournisseurs de messages non intégrés à Missive.

{% hint style="warning" %}
Cet endpoint est réservé aux **Canaux personnalisés**. Il crée des messages entrants (en simulant des messages reçus d’un système externe).

**Pour répondre à un e-mail ou envoyer un nouvel e-mail**, utilisez le [endpoint Drafts](#drafts) avec `send: true` à la place.
{% endhint %}

{% code title="payload de la requête" %}

```json
{
  "messages": {
    "account": "fbf74c47-d0a0-4d77-bf3c-2118025d8102",
    "from_field": {
      "id": "12345",
      "username": "@philippe",
      "name": "Philippe Lehoux"
    },
    "to_fields": [
      {
        "id": "54321",
        "username": "@missiveapp",
        "name": "Missive"
      }
    ],
    "body": "Hello <b>world</b>!"
  }
}
```

{% endcode %}

**Attributs**

| Nom (\* obligatoire)              | Description                                                                                                                                               | Exemple                                                                                                                                        |
| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `compte`\*                        | ID du compte. Vous pouvez trouver cet ID dans les paramètres du canal personnalisé.                                                                       | `"fbf74c47-d0a0-4d77-bf3c-2118025d8102"`                                                                                                       |
| `subject`                         | Canal e-mail uniquement : chaîne                                                                                                                          | `"Bonjour"`                                                                                                                                    |
| `body`                            | Chaîne HTML ou texte selon le Type de message du canal.                                                                                                   | `"<b>Monde !</b>"`                                                                                                                             |
| `from_field`\*                    | Canal e-mail : objet avec `"address"` et `"name"` des clés. Canal texte ou HTML : objet avec `"id"`, `"username"` et `"name"` clés.                       | `{ "address": "philippe@missiveapp.com", "name": "Philippe Lehoux" }` ou `{ "id": "12345", "username": "@missiveapp", "name": "Missive" }`     |
| `to_fields`                       | Canal e-mail : tableau d’objets avec `"address"` et `"name"` des clés. Canal texte ou HTML : tableau d’objets avec `"id"`, `"username"` et `"name"` clés. | `[{ "address": "philippe@missiveapp.com", "name": "Philippe Lehoux" }]` ou `[{ "id": "12345", "username": "@missiveapp", "name": "Missive" }]` |
| `cc_fields`                       | Canal e-mail uniquement : tableau d’objets avec `"address"` et `"name"` clés.                                                                             | `[{ "address": "philippe@missiveapp.com", "name": "Philippe Lehoux" }]`                                                                        |
| `bcc_fields`                      | Canal e-mail uniquement : tableau d’objets avec `"address"` et `"name"` clés.                                                                             | `[{ "address": "philippe@missiveapp.com", "name": "Philippe Lehoux" }]`                                                                        |
| `delivered_at`                    | Horodatage de livraison du message. S’il est omis, le message est marqué comme livré au moment de la requête.                                             | `1563806347`                                                                                                                                   |
| `attachments`                     | Tableau contenant des fichiers, voir ci-dessous pour plus de détails.                                                                                     | `[{ "base64_data": "iVBORw0KGgoAAAANS...", "filename": "logo.png" }]`                                                                          |
| `external_id`                     | ID unique utilisé pour identifier les messages non e-mail (SMS, messages privés Instagram, etc.).                                                         | `"some-id-123"`                                                                                                                                |
| `references`                      | Tableau de chaînes pour l’ajout à une conversation existante.                                                                                             | `["some-reference-123"]`                                                                                                                       |
| `conversation`                    | Chaîne d’ID de conversation pour l’ajouter à une conversation existante                                                                                   | `"5bb24363-69e5-48ed-80a9-feee988bc953"`                                                                                                       |
| `team`                            | Chaîne d’ID d’équipe                                                                                                                                      | Par défaut selon les paramètres de partage du canal : boîte de réception ou Boîte d’équipe                                                     |
| `force_team`                      | booléen                                                                                                                                                   | `faux`                                                                                                                                         |
| `organisation`                    | Chaîne d’ID de l’Organisation                                                                                                                             | `"90beb742-27a3-44cf-95bc-7e5097167c9d"`                                                                                                       |
| `ajouter_des_utilisateurs`        | Array de chaînes d’ID utilisateur                                                                                                                         | `["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]`                                                                                                     |
| `Ajouter des responsables`        | Array de chaînes d’ID utilisateur                                                                                                                         | `["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]`                                                                                                     |
| `remove_assignees`                | Array de chaînes d’ID utilisateur                                                                                                                         | `["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]`                                                                                                     |
| `conversation_subject`            | string                                                                                                                                                    | `"Nouvel utilisateur !"`                                                                                                                       |
| `conversation_color`              | Code couleur HEX ou `"good"` `"warning"` `"danger"` string                                                                                                | `"#000"`, `"danger"`                                                                                                                           |
| `add_shared_labels`               | Tableau de chaînes d’identifiants de libellés partagés                                                                                                    | `["9825718b-3407-40b8-800d-a27361c86102"]`                                                                                                     |
| `supprimer_les_libellés_partagés` | Tableau de chaînes d’identifiants de libellés partagés                                                                                                    | `["e4aae78f-e932-40a2-9ece-ed764aa85790"]`                                                                                                     |
| `ajouter_à_la_boîte_de_réception` | booléen                                                                                                                                                   | Par défaut selon les paramètres de partage du canal : boîte de réception ou Boîte d’équipe                                                     |
| `add_to_team_inbox`               | booléen                                                                                                                                                   | Par défaut selon les paramètres de partage du canal : boîte de réception ou Boîte d’équipe                                                     |
| `terminer`                        | booléen                                                                                                                                                   | `faux`                                                                                                                                         |

`attachments`

Le `attachments` le tableau vous permet de joindre des fichiers aux messages. La charge utile JSON totale de votre requête ne doit pas dépasser 10 Mo.

| Nom (\* obligatoire) | Description                            | Exemple                  |
| -------------------- | -------------------------------------- | ------------------------ |
| `base64_data`\*      | Le contenu du fichier encodé en base64 | `"iVBORw0KGgoAAAANS..."` |
| `filename`\*         | Nom de fichier de la pièce jointe      | `"logo.png"`             |

`references`

Le `references` le tableau vous permet d’ajouter un message à une conversation existante. Comme une conversation existe déjà et inclut un message avec `external_id: "some-id-123"` ou `references: ["some-id-123"]`, vous pouvez ajouter `"references": ["some-id-123"]` à votre requête afin que le message soit ajouté à cette conversation.

Si les références transmises dans la requête se rapportent à plus d’une conversation, le message sera ajouté à la première conversation trouvée. Si aucune référence n’est fournie, le message sera créé dans une nouvelle conversation. Si une ou plusieurs références sont fournies mais qu’aucune ne correspond à une conversation existante, le message sera créé dans une nouvelle conversation.

`conversation`

Si vous connaissez l’ID d’une conversation Missive existante dans laquelle vous souhaitez créer votre message, vous pouvez le transmettre comme `conversation` au lieu d’utiliser `references`.

`team`

`team` vous permet de lier la conversation du message à une équipe. Lorsqu’une conversation est déjà liée à une équipe, ce champ est ignoré.

`force_team`

`force_team` vous permet de forcer une nouvelle équipe même si la conversation se trouve déjà dans une autre équipe.

`organisation`

`organisation` vous permet de limiter la recherche de conversations à celles déjà associées à une organisation. Si une nouvelle conversation est créée et `organisation` est transmis, le message sera lié à cette Organisation.

`ajouter_des_utilisateurs`

`ajouter_des_utilisateurs` détermine les utilisateurs qui auront accès à la conversation. Lors de la transmission de `ajouter_des_utilisateurs`, le `organisation` Le champ est obligatoire.

`Ajouter des responsables`

`Ajouter des responsables` vous permet d’assigner des utilisateurs à la conversation. Les responsables existants resteront assignés. Lors de la transmission de `Ajouter des responsables`, le `organisation` Le champ est obligatoire.

`remove_assignees`

`remove_assignees` vous permet de retirer des responsables de la conversation. Lors de la transmission de `remove_assignees`, le `organisation` Le champ est obligatoire.

`ajouter_des_libellés_partagés, supprimer_des_libellés_partagés`

`add_shared_labels` et `supprimer_les_libellés_partagés` vous permettent de gérer les Libellés partagés appliqués à la conversation du message.

`add_to_team_inbox`

`add_to_team_inbox` vous permet de déplacer la conversation du message vers une boîte d’équipe. Lors de la fourniture de `add_to_team_inbox`, le `team` Le champ est obligatoire.

`ajouter_à_la_boîte_de_réception`

`ajouter_à_la_boîte_de_réception` vous permet de déplacer la conversation du message vers la boîte de réception pour toutes les personnes ayant accès à la conversation.

`terminer`

`terminer` vous permet de terminer la conversation du message pour toute personne ayant accès à la conversation.

### Obtenir un message

`GET /v1/messages/:id`

Récupérez les en-têtes, le corps et les pièces jointes d’un message spécifique à l’aide du message `id`.

Pour récupérer plusieurs messages en un seul appel, passez des identifiants de message séparés par des virgules :

`GET /v1/messages/:id,:id2,:id3`

{% code title="Réponse pour un seul message" %}

```json
{
  "messages": {
    "id": "3fa4bcf5-e57e-47a4-9422-de2cce5f802e",
    "subject": "A Message",
    "preview": "A message from Sam",
    "type": "email",
    "delivered_at": 1563806347,
    "updated_at": 1563807320,
    "created_at": 1563807320,
    "email_message_id": "<0f1ab2d8-cd90-4dd1-a861-ef7e31fb3cdd@missiveapp.com>",
    "in_reply_to": [],
    "references": [],
    "body": "<div>A message from Sam</div><br><img style=\"max-width: 100%\" alt=\"inline-image.png\" data-missive-attachment-id=\"81eed561-4908-4738-9a9f-2da886b1de43\">",
    "from_field": {
      "name": "Samwise Gamgee",
      "address": "sam@fellowship.org"
    },
    "to_fields": [
      {
        "name": "Phil Smith",
        "address": "phil.smith@fakemail.com"
      }
    ],
    "cc_fields": [],
    "bcc_fields": [],
    "reply_to_fields": [],
    "attachments": [
      {
        "id": "81eed561-4908-4738-9a9f-2da886b1de43",
        "filename": "inline-image.png",
        "extension": "png",
        "url": "https://...",
        "media_type": "image",
        "sub_type": "png",
        "size": 114615,
        "width": 668,
        "height": 996
      }
    ],
    "conversation": {
      "id": "47a57b76-df42-4d8k-927x-80dbe5d87191",
      "subject": null,
      "latest_message_subject": "A Message",
      "organisation": {
        "id": "93e5e5d5-11a2-4c9b-80b8-94f3c08068cf",
        "name": "Fraternité"
      },
      "team": {
        "id": "2f618f9e-d3d4-4a01-b7d5-57124ab366b8",
        "name": "Hobbits",
        "organisation": "93e5e5d5-11a2-4c9b-80b8-94f3c08068cf"
      },
      "color": null,
      "assignees": [
        {
          "id": "6b52b6b9-9b51-46ad-a4e3-82ef3c45512c",
          "name": "Frodo Baggins",
          "email": "frodo@fellowship.org",
          "unassigned": false,
          "closed": false,
          "archived": false,
          "trashed": false,
          "junked": false,
          "assigned": true,
          "flagged": false,
          "snoozed": true
        }
      ],
      "assignee_names": "Frodo Baggins",
      "assignee_emails": "frodo@fellowship.org",
      "Utilisateurs": [
        {
          "id": "6b52b6b9-9b51-46ad-a4e3-82ef3c45512c",
          "name": "Frodo Baggins",
          "email": "frodo@fellowship.org",
          "unassigned": false,
          "closed": false,
          "archived": false,
          "trashed": false,
          "junked": false,
          "assigned": true,
          "flagged": false,
          "snoozed": true
        }
      ],
      "attachments_count": 0,
      "messages_count": 1,
      "authors": [
        {
          "name": "Samwise Gamgee",
          "address": "sam@fellowship.org"
        }
      ],
      "drafts_count": 0,
      "send_later_messages_count": 0,
      "tasks_count": 0,
      "completed_tasks_count": 0,
      "shared_labels": [
        {
          "id": "146ff5c4-d5la-3b63-b994-76711fn790lq",
          "name": "Elfs"
        }
      ],
      "shared_label_names": "Elfs",
      "app_url": "missive://mail.missiveapp.com/#inbox/conversations/47a57b76-df42-4d8k-927x-80dbe5d87191",
      "web_url": "https://mail.missiveapp.com/#inbox/conversations/47a57b76-df42-4d8k-927x-80dbe5d87191"
    }
  }
}
```

{% endcode %}

Lorsque vous récupérez plusieurs messages avec des ID séparés par des virgules, la réponse renvoie un tableau d’objets message sous le `messages` clé, au même format que ci-dessus.

Images intégrées

Balisage des images intégrées dans le message `body` Le HTML ne contient aucun `src` attribut, ils contiennent plutôt un `data-missive-attachment-id` attribut avec la pièce jointe `id`. La pièce jointe et son URL sont disponibles dans la réponse GET sous le `attachments` clé.

### Lister les messages

`GET /v1/messages?email_message_id=Message-ID`

Récupérer les messages correspondant à un e-mail `Message-ID`.

{% code title="Réponse" %}

```json
{
  "messages": [
    {
      // Dernier message
    },
    {
      // Avant-dernier message
    }
  ]
}
```

{% endcode %}

Les données du message incluent les en-têtes, le corps et les pièces jointes dans le même format que « Obtenir un message ».

La plupart du temps, un seul message correspond à un Message-ID donné, comme l’exigent les standards de l’e-mail. Cependant, des serveurs expéditeurs non conformes peuvent vous envoyer plusieurs messages avec le même Message-ID ; dans ce cas, cet endpoint renverra les 10 plus récents.

**Paramètres**

| Nom (\* obligatoire) | Par défaut | Description                                        |
| -------------------- | ---------- | -------------------------------------------------- |
| `email_message_id`\* | \`\`       | Le `Message-ID` trouvé dans l’en-tête d’un e-mail. |

***

## Organisations

### Lister les Organisations

`GET /v1/Organisations`

Répertoriez les Organisations dont l’utilisateur authentifié fait partie.

{% code title="Réponse" %}

```json
{
  "Organisations": [
    {
      "id": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92",
      "name": "Badge de conférence"
    }
  ]
}
```

{% endcode %}

**Paramètres**

| Nom (\* obligatoire) | Par défaut | Description                                               |
| -------------------- | ---------- | --------------------------------------------------------- |
| `limit`              | `50`       | Nombre d’organisations renvoyées. Valeur maximale : `200` |
| `offset`             | `0`        | Décalage utilisé pour la pagination.                      |

**Propriétés de l’Organisation**

| Nom (\* toujours présent) | Description            |
| ------------------------- | ---------------------- |
| `id`\*                    | UUID de l’Organisation |
| `name`\*                  | Nom de l’Organisation  |

***

## Réponses

### Lister les Réponses

`GET /v1/responses`

Lister les Réponses de l’utilisateur authentifié.

{% code title="Réponse" %}

```json
{
  "Réponses": [
    {
      "id": "75ad834a-9bd6-4008-b9e6-fc9fa2e7770b",
      "title": "Une réponse de test",
      "body": "<div>Image intégrée : <img alt=\"\" title=\"\" width=\"288\" data-missive-attachment-id=\"66d17982-4c83-4e13-a9c5-83cf6065b3da\" data-missive-resizable-image=\"true\" data-missive-image-resolution=\"144\" style=\"max-width: 100%\"></div>",
      "subject": null,
      "organization": "84f876cc-ef7c-41cd-9711-7ab9cf9f26a5",
      "user": null,
      "share_with_team": null,
      "modified_at": 1700150379,
      "to_fields": [],
      "cc_fields": [],
      "bcc_fields": [],
      "shared_labels": ["93f876cc-ef7c-42cd-9711-7ab9cf9f26a4"],
      "attachments": [
        {
          "id": "66d17982-4c83-4e13-a9c5-83cf6065b3da",
          "filename": "image.png",
          "extension": "png",
          "url": "...",
          "media_type": "image",
          "sub_type": "png",
          "size": 99,
          "width": 100,
          "height": 100
        }
      ]
    }
  ]
}
```

{% endcode %}

**Paramètres**

| Nom (\* obligatoire) | Par défaut | Description                                           |
| -------------------- | ---------- | ----------------------------------------------------- |
| `organisation`       | `null`     | ID de l’Organisation                                  |
| `limit`              | `50`       | Nombre de Réponses renvoyées. Valeur maximale : `200` |
| `offset`             | `0`        | Décalage utilisé pour la pagination.                  |

Images intégrées

Balisage des images intégrées dans la réponse `body` Le HTML ne contient aucun `src` attribut, ils contiennent plutôt un `data-missive-attachment-id` attribut avec la pièce jointe `id`. La pièce jointe et son URL sont disponibles dans la réponse GET sous le `attachments` clé.

**Propriétés de la réponse**

La même structure est renvoyée par [Lister les Réponses](#list-responses), [Obtenir une réponse](#get-a-response), [Créer une réponse(s)](#create-response-s), et [Mettre à jour les réponses](#update-response-s).

| Nom (\* toujours présent) | Description                                                               |
| ------------------------- | ------------------------------------------------------------------------- |
| `id`\*                    | UUID de la réponse                                                        |
| `titre`\*                 | Titre de la réponse                                                       |
| `body`\*                  | Corps HTML de la réponse                                                  |
| `subject`                 | Objet                                                                     |
| `modified_at`\*           | Horodatage Unix de la dernière modification de la réponse                 |
| `organisation`            | UUID de l’Organisation                                                    |
| `utilisateur`             | UUID de l’utilisateur pour les réponses personnelles                      |
| `share_with_team`         | UUID de l’équipe lorsqu’il est limité à une équipe                        |
| `libellés_partagés`\*     | Tableau des UUID des libellés partagés                                    |
| `to_fields`\*             | Tableau d’objets destinataires (`address`, `name`)                        |
| `cc_fields`\*             | Array d’objets destinataires en Cc                                        |
| `bcc_fields`\*            | Tableau d’objets destinataires BCC                                        |
| `attachments`\*           | Tableau d’objets de pièce jointe (voir les propriétés de la pièce jointe) |
| `external_id`             | Identifiant externe                                                       |
| `source externe`          | Identifiant de source externe                                             |

### Obtenir une réponse

`GET /v1/responses/:id`

Récupérez une réponse spécifique à l’aide de la réponse `id`.

### Créer une réponse(s)

`POST /v1/réponses`

{% code title="payload de la requête" %}

```json
{
  "Réponses": [
    {
      "title": "Modèle d’e-mail de bienvenue",
      "body": "<p>Bienvenue sur notre service !</p>",
      "organization": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92",
      "subject": "Welcome!",

      "external_id": "template-001",
      "external_source": "knowledge-base"
    }
  ]
}
```

{% endcode %}

Une requête réussie renverra les Réponses nouvellement créées.

{% code title="Réponse" %}

```json
{
  "Réponses": [
    {
      "id": "75ad834a-9bd6-4008-b9e6-fc9fa2e7770b",
      "title": "Modèle d’e-mail de bienvenue",
      "body": "<p>Bienvenue sur notre service !</p>",
      "subject": "Welcome!",

      "organization": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92",
      "user": null,
      "share_with_team": null,
      "modified_at": 1700150379,
      "to_fields": [],
      "cc_fields": [],
      "bcc_fields": [],
      "shared_labels": [],
      "external_id": "template-001",
      "external_source": "knowledge-base",
      "attachments": []
    }
  ]
}
```

{% endcode %}

**Attributs**

| Nom (\* obligatoire) | Description                                                                                                                                         | Exemple                                                             |
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `titre`              | Chaîne du titre de la réponse (500 caractères max)                                                                                                  | `« Modèle d’e-mail de bienvenue »`                                  |
| `organisation`       | Chaîne d’ID de l’Organisation. Soit `organisation` ou `utilisateur` est requis (mais pas les deux).                                                 | `"0d9bab85-a74f-4ece-9142-0f9b9f36ff92"`                            |
| `utilisateur`        | Chaîne d’ID utilisateur pour les réponses personnelles. Soit `organisation` ou `utilisateur` est requis (mais pas les deux).                        | `"a41a00fd-453d-49d7-a487-9765c35a3b70"`                            |
| `body`               | Chaîne HTML contenant le contenu de la réponse                                                                                                      | `"<p>Hello!</p>"`                                                   |
| `subject`            | Chaîne de ligne d’objet (500 caractères max)                                                                                                        | `"Welcome!"`                                                        |
| `share_with_team`    | Chaîne d’ID d’équipe pour partager la réponse avec une équipe spécifique. `organisation` est requis                                                 | `"646bb7f1-2066-40be-b8f6-bacb8b3b7419"`                            |
| `libellés_partagés`  | Tableau de chaînes d’ID de libellés partagés. `organisation` est requis                                                                             | `["9825718b-3407-40b8-800d-a27361c86102"]`                          |
| `to_fields`          | Tableau d’objets avec `"address"` et `"name"` clés                                                                                                  | `[{"address": "support@example.com", "name": "Support"}]`           |
| `cc_fields`          | Tableau d’objets avec `"address"` et `"name"` clés                                                                                                  | `[{"address": "manager@example.com", "name": "Manager"}]`           |
| `bcc_fields`         | Tableau d’objets avec `"address"` et `"name"` clés                                                                                                  | `[{"address": "archive@example.com"}]`                              |
| `external_id`        | Chaîne d’identifiant externe pour la synchronisation avec d’autres systèmes. Lorsqu’elle est fournie, `source externe` est obligatoire.             | `"template-001"`                                                    |
| `source externe`     | Chaîne d’identifiant du système source. Requise lorsque `external_id` est fournie. La combinaison doit être unique par organisation ou utilisateur. | `"knowledge-base"`                                                  |
| `attachments`        | Tableau contenant des fichiers, voir ci-dessous pour plus de détails                                                                                | `[{"base64_data": "iVBORw0KGgoAAAANS...", "filename": "logo.png"}]` |

`attachments`

Le `attachments` array vous permet de joindre des fichiers à la réponse. La payload JSON totale de votre requête ne doit pas dépasser 10 Mo.

| Nom (\* obligatoire) | Description                                                                                      | Exemple                  |
| -------------------- | ------------------------------------------------------------------------------------------------ | ------------------------ |
| `base64_data`\*      | Le contenu du fichier encodé en base64                                                           | `"iVBORw0KGgoAAAANS..."` |
| `filename`\*         | Nom de fichier de la pièce jointe                                                                | `"logo.png"`             |
| `id`                 | ID temporaire pour les références d’images en ligne (voir la section Images en ligne ci-dessous) | `"img1"`                 |

Images intégrées

Pour intégrer des images en ligne dans le corps de la réponse, utilisez un ID temporaire `id` dans la pièce jointe et faites-y référence dans le HTML à l’aide de l’ `data-missive-attachment-id` attribut :

{% code title="payload de la requête" %}

```json
{
  "Réponses": [
    {
      "title": "Réponse avec image en ligne",
      "organization": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92",
      "body": "<p>Voir notre logo :</p><p><img data-missive-attachment-id=\"logo-img\" style=\"max-width: 100%\" /></p>",
      "attachments": [
        {
          "id": "logo-img", 
          "filename": "logo.png",
          "base64_data": "iVBORw0KGgoAAAANS..."
        }
      ]
    }
  ]
}
```

{% endcode %}

Le serveur remplacera le temporaire `id` avec l’UUID réel de la pièce jointe. Les pièces jointes avec un `id` qui est référencée dans le HTML du corps sera traitée comme une image intégrée ; les pièces jointes sans référence dans le corps seront traitées comme des pièces jointes classiques.

### Mettre à jour les réponses

`PATCH /v1/responses/:id1,:id2,:id3,...`

Une requête réussie renverra les Réponses mises à jour.

{% code title="payload de la requête" %}

```json
{
  "Réponses": [
    {
      "id": "75ad834a-9bd6-4008-b9e6-fc9fa2e7770b",
      "title": "Modèle de bienvenue mis à jour",
      "body": "<p>Bonjour {{name}},</p><p>Bienvenue à bord !</p>"
    }
  ]
}
```

{% endcode %}

**Attributs**

Réponse `id` est obligatoire. Consultez la section Créer une réponse pour les autres attributs. Lors de la mise à jour d’une réponse, vous pouvez transmettre uniquement les attributs que vous souhaitez mettre à jour. Dans l’exemple ci-dessus, seuls les attributs title et body seront mis à jour.

{% hint style="warning" %}
Quand le `attachments` si un tableau est transmis, vous devez transmettre toutes les pièces jointes que vous souhaitez conserver. Les pièces jointes manquantes seront supprimées de la réponse.
{% endhint %}

{% hint style="info" %}
Les Réponses créées par des Intégrations externes (comme les modèles WhatsApp) ne peuvent pas être mises à jour via cet endpoint.
{% endhint %}

### Supprimer la/les réponse(s)

`DELETE /v1/responses/:id1,:id2,:id3,...`

Supprime une ou plusieurs Réponses.

Pour les réponses de l’organisation dans les organisations où la gestion restreinte des réponses est activée (fonctionnalité du forfait Entreprise), seuls les administrateurs et propriétaires de l’organisation sont autorisés à supprimer les réponses.

{% hint style="info" %}
Les Réponses créées par des Intégrations externes (telles que les modèles WhatsApp) ne peuvent pas être supprimées via cet endpoint.
{% endhint %}

***

## Publications

L’endpoint posts vous permet d’injecter des données dans n’importe quelle conversation Missive et de gérer l’état de la conversation. Vous pouvez créer des posts dans Nouvelles conversations ou les ajouter aux conversations existantes.

Les posts sont la façon recommandée de gérer les conversations (terminer, déplacer dans la boîte de réception, assigner des utilisateurs, ajouter des libellés) depuis les intégrations et les automatisations. Chaque post laisse une trace visible dans la conversation, montrant ce qui a déclenché l’action.

Exemple d’utilisation : chaque fois que quelqu’un pousse du code sur GitHub, créez une publication qui liste les commits. Lorsqu’un ticket d’assistance est résolu dans votre système, créez une publication qui termine la conversation.

### Gérer les conversations avec des publications

Utilisez des publications pour effectuer des Actions de conversation tout en laissant une trace indiquant quelle intégration a déclenché la modification. Voici les actions courantes :

| Pour faire cela                                   | Utilisez ces paramètres                           |
| ------------------------------------------------- | ------------------------------------------------- |
| Terminer une conversation                         | `close: true`                                     |
| Rouvrir une conversation                          | `reopen: true`                                    |
| Déplacer vers la boîte de réception (désarchiver) | `add_to_inbox: true`                              |
| Déplacer vers une boîte d’équipe                  | `add_to_team_inbox: true` et `équipe : "team-id"` |
| Assigner des utilisateurs                         | `add_assignees: ["user-id"]`                      |
| Retirer les responsables                          | `remove_assignees: ["user-id"]`                   |
| Ajouter des libellés                              | `add_shared_labels: ["label-id"]`                 |
| Retirer les libellés                              | `remove_shared_labels: ["label-id"]`              |
| Définir la couleur de la conversation             | `conversation_color: "#ff0000"`                   |
| Changer d’équipe                                  | `équipe : "team-id"` et `force_team: true`        |

{% hint style="warning" %}
**Archivage non disponible**: Il n’existe actuellement aucun paramètre pour archiver les conversations via l’API.
{% endhint %}

**Exemple : Terminer une conversation avec une publication personnalisée**

{% code title="Demande" %}

```json
{
  "posts": {
    "conversation": "00f78fe9-f11a-4b4e-a502-67e6138d3b0f",
    "notification": {
      "title": "Ticket résolu",
      "body": "Ce ticket d’assistance a été marqué comme résolu"
    },
    "username": "Support System",
    "text": "Le ticket n°1234 a été résolu et marqué comme terminé.",
    "close": true
  }
}
```

{% endcode %}

Cela crée une publication dans la conversation et la termine. Les membres de l’équipe verront la publication expliquant pourquoi la conversation a été terminée.

### Créer une publication

`POST /v1/posts`

{% code title="payload de la requête" %}

```json
{
  "posts": {
    "conversation": "00f78fe9-f11a-4b4e-a502-67e6138d3b0f",
    "notification": { "title": "Un titre", "body": "Un texte" },
    "username": "Missive",
    "username_icon": "https://s3.amazonaws.com/missive-assets/missive-avatar.png",
    "attachments": [
      {
        "author_name": "Philippe Lehoux",
        "author_link": "mailto:philippe@missiveapp.com",
        "author_icon": "avatar:philippe@missiveapp.com",
        "color": "#2266ED",
        "text": "Un nouveau client s’est inscrit !",
        "timestamp": 1511540318
      }
    ]
  }
}
```

{% endcode %}

{% code title="Réponse" %}

```json
{
  "posts": {
    "conversation": "00f78fe9-f11a-4b4e-a502-67e6138d3b0f",
    "id": "ee31f156-db95-4158-923f-b26450e0dbf7"
  }
}
```

{% endcode %}

La réponse comprend :

* `conversation`: ID de la conversation à laquelle la publication a été ajoutée
* `id`: ID de la publication (utilisez cet ID pour supprimer la publication)

**Attributs**

| Nom (\* obligatoire)              | Description                                                                                       | Exemple                                                        |
| --------------------------------- | ------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
| `username`                        | Nom de l’auteur de la publication, utilisé à la place du nom du propriétaire du API token         | `"Missive"`                                                    |
| `username_icon`                   | Image de l’auteur de la publication, utilisée à la place de l’avatar du propriétaire du API token | `"https://s3.amazonaws.com/missive-assets/missive-avatar.png"` |
| `conversation_icon`               | Image utilisée comme l’icône dans la liste des conversations                                      | `"https://s3.amazonaws.com/missive-assets/missive-avatar.png"` |
| `conversation_subject`            | string                                                                                            | `"Nouvel utilisateur !"`                                       |
| `conversation_color`              | Code couleur HEX ou `"good"` `"warning"` `"danger"` string                                        | `"#000"`, `"danger"`                                           |
| `text`                            | Message principal d’une publication                                                               | `"Ceci est une publication !"`                                 |
| `markdown`                        | Message principal d’une publication, formaté en Markdown                                          | `"Ceci est un **post** !"`                                     |
| `notification`\*                  | Objet contenant les clés "title" et "body", utilisé pour afficher une notification                | `{"title":"Un titre", "body": "Un texte"}`                     |
| `attachments`                     | Tableau contenant des objets de pièce jointe, voir ci-dessous pour plus de détails                | `[{"text": "Ceci est une pièce jointe !"}]`                    |
| `references`                      | Tableau de chaînes pour l’ajout à une conversation existante.                                     | `["<some-reference-123>"]`                                     |
| `conversation`                    | Chaîne d’ID de conversation pour l’ajouter à une conversation existante                           | `"5bb24363-69e5-48ed-80a9-feee988bc953"`                       |
| `organisation`                    | Chaîne d’ID de l’Organisation                                                                     | `"90beb742-27a3-44cf-95bc-7e5097167c9d"`                       |
| `team`                            | Chaîne d’ID d’équipe                                                                              | `"646bb7f1-2066-40be-b8f6-bacb8b3b7419"`                       |
| `force_team`                      | booléen                                                                                           | `faux`                                                         |
| `ajouter_des_utilisateurs`        | Array de chaînes d’ID utilisateur                                                                 | `["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]`                     |
| `Ajouter des responsables`        | Array de chaînes d’ID utilisateur                                                                 | `["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]`                     |
| `remove_assignees`                | Array de chaînes d’ID utilisateur                                                                 | `["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]`                     |
| `add_shared_labels`               | Tableau de chaînes d’identifiants de libellés partagés                                            | `["9825718b-3407-40b8-800d-a27361c86102"]`                     |
| `supprimer_les_libellés_partagés` | Tableau de chaînes d’identifiants de libellés partagés                                            | `["e4aae78f-e932-40a2-9ece-ed764aa85790"]`                     |
| `ajouter_à_la_boîte_de_réception` | booléen                                                                                           | `faux`                                                         |
| `add_to_team_inbox`               | booléen                                                                                           | `faux`                                                         |
| `terminer`                        | booléen                                                                                           | `faux`                                                         |
| `rouvrir`                         | booléen                                                                                           | `vrai`                                                         |

Validations

* L’un ou l’autre `text`, `markdown` ou `attachments` est obligatoire.
* Le `text` et `markdown` Les champs ont une longueur maximale de 8000 caractères.
* Le payload JSON total de votre requête ne doit pas dépasser 10 Mo.

`references`

Le `references` array vous permet d’ajouter un message à une conversation existante. Lorsqu’une conversation existe déjà et qu’elle inclut un e-mail avec un `Message-ID: <a@a.com>` ou `References: <a@a.com>` en-tête, vous pouvez ajouter `"references": ["<a@a.com>"]` à votre requête afin que le message soit ajouté à cette conversation.

Si les références transmises dans la requête sont liées à plus d’une conversation, le message ne sera inséré que dans la première conversation trouvée. Si aucune référence n’est fournie, le message sera inséré dans une nouvelle conversation. Si une ou plusieurs références sont fournies, mais qu’aucune ne correspond à une conversation existante, le message sera inséré dans une nouvelle conversation.

Les chevrons autour des références sont facultatifs. Les deux `["<some-reference-123>"]` et `["some-reference-123"]` fera référence à la même conversation.

`conversation`

Si vous connaissez l’ID d’une conversation Missive existante dans laquelle vous souhaitez créer votre message, vous pouvez le transmettre en tant que `conversation` au lieu d’utiliser `references`.

`organisation`

`organisation` vous permet de limiter la recherche de conversations à celles déjà associées à une Organisation. Si une nouvelle conversation est créée et `organisation` est transmis, la conversation sera liée à cette Organisation.

`team`

`team` vous permet de lier la conversation de la publication à une équipe. Lorsqu’une conversation est déjà liée à une équipe, ce champ est ignoré.

`force_team`

`force_team` vous permet de forcer une nouvelle équipe même si la conversation se trouve déjà dans une autre équipe.

`ajouter_des_utilisateurs`

`ajouter_des_utilisateurs` détermine les utilisateurs qui auront accès à la conversation. Lors de la transmission de `ajouter_des_utilisateurs`, le `organisation` Le champ est obligatoire.

`Ajouter des responsables`

`Ajouter des responsables` vous permet d’assigner des utilisateurs à la conversation. Les responsables existants resteront assignés. Lors de la transmission de `Ajouter des responsables`, le `organisation` Le champ est obligatoire.

`remove_assignees`

`remove_assignees` vous permet de retirer des responsables de la conversation. Lors de la transmission de `remove_assignees`, le `organisation` Le champ est obligatoire.

`ajouter_des_libellés_partagés, supprimer_des_libellés_partagés`

`add_shared_labels` et `supprimer_les_libellés_partagés` vous permettent de gérer les Libellés partagés appliqués à la conversation de la publication.

`add_to_team_inbox`

`add_to_team_inbox` déplace la conversation vers une boîte d’équipe pour toute personne qui y a accès. Lors de la fourniture de `add_to_team_inbox`, le `team` ce champ est obligatoire. Une trace de cette action apparaîtra dans la conversation.

`ajouter_à_la_boîte_de_réception`

`ajouter_à_la_boîte_de_réception` déplace la conversation vers la boîte de réception pour toute personne qui y a accès (restaure la conversation). Une trace de cette action apparaîtra dans la conversation.

`terminer`

`terminer` termine la conversation pour toute personne qui y a accès. Une trace de cette action apparaîtra dans la conversation.

`rouvrir`

`rouvrir` Empêche les conversations terminées de se rouvrir lors de la création d’un post. Définissez-le sur `vrai` pour garder la conversation terminée même après l’ajout du nouveau post.

`attachments`

Le `attachments` array prend en charge deux types de pièces jointes :

**1. Blocs de pièces jointes formatés** avec les champs suivants :

| Nom           | Description                                                                 | Exemple                                         |
| ------------- | --------------------------------------------------------------------------- | ----------------------------------------------- |
| `color`       | Code couleur HEX ou `"good"` `"warning"` `"danger"` string                  | `"#ccc"`, `"danger"`                            |
| `pretext`     | Text string                                                                 | `"This is a pretext!"`                          |
| `author_name` | Nom de l’auteur de la pièce jointe                                          | `« Utilisateur - Phil »`                        |
| `author_link` | URL menant à l’auteur                                                       | `"https://admin.myapp.com/users/phil"`          |
| `author_icon` | URL de l’image de l’auteur de la pièce jointe                               | `"https://myapp.com/phil.png"`                  |
| `titre`       | Titre de la pièce jointe                                                    | `« Ceci est un titre ! »`                       |
| `title_link`  | URL pointant vers la ressource de la pièce jointe                           | `"https://myapp.com/a-resource"`                |
| `image_url`   | URL de l’image de la pièce jointe                                           | `"https://myapp.com/a-resource.png"`            |
| `text`        | Text string                                                                 | `"Ceci est du texte !"`                         |
| `markdown`    | Chaîne de texte, mise en forme avec Markdown                                | `"Ceci est un **texte en gras** !"`             |
| `timestamp`   | Valeur entière en temps Unix                                                | `1512395766`                                    |
| `footer`      | Text string                                                                 | `"Ceci est un pied de page !"`                  |
| `footer_icon` | URL de l’image du pied de page de la pièce jointe                           | `"https://myapp.com/logo.png"`                  |
| `fields`      | Tableau contenant des objets de champ, voir ci-dessous pour plus de détails | `[{"title": "Paying customer","value": "yes"}]` |

**2. Pièces jointes de fichiers binaires** en utilisant le même format que les brouillons et les messages :

| Nom (\* obligatoire) | Description                            | Exemple                  |
| -------------------- | -------------------------------------- | ------------------------ |
| `base64_data`\*      | Le contenu du fichier encodé en base64 | `"iVBORw0KGgoAAAANS..."` |
| `filename`\*         | Nom de fichier de la pièce jointe      | `"logo.png"`             |

Formats de rendu intégré pris en charge : JPEG, PNG, GIF (images), MOV, MP4 (vidéo), MP3 (audio). Les autres types de fichiers apparaîtront comme des pièces jointes téléchargeables.

`attachments.fields`

| Nom (\* obligatoire) | Description                                                                           | Exemple               |
| -------------------- | ------------------------------------------------------------------------------------- | --------------------- |
| `titre`              | Text string                                                                           | `« client payant ? »` |
| `value`              | Text string                                                                           | `« oui »`             |
| `court`              | Booléen. Si la valeur est vraie, il y aura deux champs par ligne, sinon un par ligne. | `vrai`                |

### Supprimer un post

`DELETE /v1/posts/:id`

Supprime un post d’une conversation. Le `:id` Le paramètre est l’ID de la publication (renvoyé dans la réponse de création de publication).

{% hint style="info" %}
Pour les conversations partagées, l’API token doit être généré par un administrateur de l’Organisation propriétaire de la conversation. Seuls le propriétaire de l’Organisation et les administrateurs ont l’autorisation de supprimer les messages dans les conversations partagées avec leur Organisation.
{% endhint %}

***

## Libellés partagés

### Créer des libellés partagés

`POST /v1/shared_labels`

{% code title="payload de la requête" %}

```json
{
  "shared_labels": [
    {
      "name": "Heroku",
      "color": "#430098",
      "parent": "b45a00fd-353s-89l2-a487-2465c35c3r91",
      "Organisation": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92"
    }
  ]
}
```

{% endcode %}

Une requête réussie renverra les libellés partagés nouvellement créés.

{% code title="Réponse" %}

```json
{
  "shared_labels": [
    {
      "id": "6960dfv2-4382-4230-aa70-933a1c62040b",
      "name": "Heroku",
      "name_with_parent_names": "Factures/Heroku",
      "color": "#430098",
      "parent": "b45a00fd-353s-89l2-a487-2465c35c3r91",
      "Organisation": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92"
    }
  ]
}
```

{% endcode %}

**Attributs**

| Nom (\* obligatoire)             | Description                                               | Exemple                                   |
| -------------------------------- | --------------------------------------------------------- | ----------------------------------------- |
| `name`\*                         | Chaîne du nom du libellé                                  | `"Heroku"`                                |
| `organisation`\*                 | Chaîne d’ID de l’Organisation                             | `"0d9bab85-a74f-4ece-9142-0f9b9f36ff92"`  |
| `color`                          | Code couleur HEX                                          | `"#430098"`                               |
| `parent`                         | Chaîne d’ID du libellé partagé parent                     | `"9b45a00fd-353s-89l2-a487-2465c35c3r91"` |
| `share_with_organization`        | Booléen                                                   | `vrai`                                    |
| `share_with_team`                | Chaîne d’ID d’équipe                                      | `nil`                                     |
| `partager_avec_les_utilisateurs` | Array de chaînes d’ID utilisateur                         | `[]`                                      |
| `visibilité`                     | L’un ou l’autre `'Organisation'` ou `« délégués »` string | `'Organisation'`                          |

`share_with_organization`, `share_with_team`, `partager_avec_les_utilisateurs`\
Les utilisateurs concernés par l’un ou l’autre de ces paramètres auront accès à toutes les conversations du libellé.

`visibilité`

Le paramètre visibility contrôle à qui le libellé est visible par. Si la valeur est `organisation`, tout le monde dans l’organisation peut utiliser le libellé. Si la valeur est `délégués`, uniquement les administrateurs et les utilisateurs en partage automatique (utilisateurs concernés par `partager_avec_les_utilisateurs`, `share_with_organization`, `share_with_team`) peut utiliser le libellé.

### Mettre à jour les libellés partagés

`PATCH /v1/shared_labels/:id1,:id2,:id3,...`

Une requête réussie renverra les libellés partagés mis à jour.

{% code title="payload de la requête" %}

```json
{
  "shared_labels": [
    {
      "id": "ee31f156-db95-4158-923f-b26450e0dbf7",
      "name": "Updated Label",
      "color": "#f96885"
    }
  ]
}
```

{% endcode %}

Attributs

Libellé partagé `id` est requis. Consultez la section Créer des libellés partagés pour les autres attributs. Vous pouvez ne transmettre que les attributs que vous souhaitez mettre à jour. Dans l’exemple ci-dessus, le nom et la couleur seront mis à jour.

Les utilisateurs de base peuvent mettre à jour :

* `name` : Le nom du libellé
* `color`: La couleur du libellé sous forme de code couleur hexadécimal (par ex. #f96885)
* `parent`: L’ID du libellé parent

Les utilisateurs administrateurs/propriétaires peuvent également mettre à jour :

* `visibilité`: Doit être soit 'delegates' soit 'Organisation'
* `share_with_organization`: Partager le libellé avec toute l’Organisation
* `share_with_team`: L’ID de l’équipe avec laquelle partager le libellé
* `partager_avec_les_utilisateurs`: Un tableau d’identifiants d’utilisateurs avec lesquels partager le libellé

### Lister les libellés partagés

`GET /v1/shared_labels`

Lister les Libellés partagés dans les Organisations auxquelles l’utilisateur authentifié appartient et auxquelles il a accès.

{% code title="Réponse" %}

```json
{
  "shared_labels": [
    {
      "id": "b45a00fd-353s-89l2-a487-2465c35c3r91",
      "color": null,
      "name": "Factures",
      "name_with_parent_names": "Invoices",
      "Organisation": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92"
    }
  ]
}
```

{% endcode %}

**Paramètres**

| Nom (\* obligatoire) | Par défaut | Description                                                   |
| -------------------- | ---------- | ------------------------------------------------------------- |
| `organisation`       | `null`     | ID de l’Organisation                                          |
| `limit`              | `50`       | Nombre de libellés partagés renvoyés. Valeur maximale : `200` |
| `offset`             | `0`        | Décalage utilisé pour la pagination.                          |

**Propriétés du libellé partagé**

La même structure est renvoyée par [Lister les libellés partagés](#list-shared-labels), [Créer des libellés partagés](#create-shared-labels-s), et [Mettre à jour les libellés partagés](#update-shared-label-s).

| Nom (\* toujours présent)          | Description                                                                          |
| ---------------------------------- | ------------------------------------------------------------------------------------ |
| `id`\*                             | UUID du libellé partagé                                                              |
| `name`\*                           | Nom du libellé                                                                       |
| `name_with_parent_names`\*         | Chemin complet du libellé, y compris les noms parents, reliés par `/`                |
| `organisation`\*                   | UUID de l’Organisation                                                               |
| `color`                            | Code couleur HEX                                                                     |
| `parent`                           | UUID du libellé parent                                                               |
| `share_with_organization`\*        | Indique si le libellé est partagé avec Tout le monde dans l’organisation             |
| `share_with_team`                  | UUID de l’équipe s’il est partagé avec une équipe spécifique                         |
| `partager_avec_les_utilisateurs`\* | Tableau des UUID des utilisateurs avec lesquels le libellé est explicitement partagé |
| `visibilité`\*                     | `organisation` ou `délégués`                                                         |

***

## Équipes

### Lister les équipes

`GET /v1/teams`

Lister les équipes dans les Organisations auxquelles l’utilisateur authentifié appartient et auxquelles il a accès.

{% code title="Réponse" %}

```json
{
  "teams": [
    {
      "id": "d75aecb6-96a2-4b5f-afa6-19d1916052ea",
      "name": "Sales",
      "organization": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92",
      "active_members": ["a41a00fd-453d-49d7-a487-9765c35a3b70"],
      "observers": [],
      "team_inbox_enabled": true,
      "chat_room_enabled": true,
      "team_mention_behavior": "all_members",
      "user_reply_behavior": "assign_user",
      "received_reply_behavior": "show_in_assignee_inbox",
      "team_sidebar_behavior": "show_team_space"
    }
  ]
}
```

{% endcode %}

**Paramètres**

| Nom (\* obligatoire) | Par défaut | Description                                     |
| -------------------- | ---------- | ----------------------------------------------- |
| `organisation`       | `null`     | ID de l’Organisation                            |
| `limit`              | `50`       | Nombre d’équipes renvoyées. Valeur max. : `200` |
| `offset`             | `0`        | Décalage utilisé pour la pagination.            |

### Créer des équipe(s)

`POST /v1/teams`

Créez une nouvelle équipe dans une Organisation. Le API token doit appartenir à un administrateur ou au propriétaire de l’Organisation.

{% tabs %}
{% tab title="De base" %}
{% code title="payload de la requête" %}

```json
{
  "teams": [
    {
      "name": "Support",
      "organization": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92",
      "active_members": ["1ce8117e-ae42-4304-b953-c81656da4bd1"]
    }
  ]
}
```

{% endcode %}
{% endtab %}

{% tab title="Exemple complet" %}
{% code title="payload de la requête" %}

```json
{
  "teams": [
    {
      "name": "Support",
      "organization": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92",
      "emoji": ":dart:",
      "color": "#2266ED",
      "active_members": [
        "1ce8117e-ae42-4304-b953-c81656da4bd1",
        "74f91030-39b8-4627-9835-9cfbce9d67c1"
      ],
      "observers": ["a41a00fd-453d-49d7-a487-9765c35a3b70"],
      "business_hours": {
        "tz": "America/Montreal",
        "t": [
          { "d": 1, "s": [32400, 61200] },
          { "d": 2, "s": [32400, 61200] },
          { "d": 3, "s": [32400, 61200] },
          { "d": 4, "s": [32400, 61200] },
          { "d": 5, "s": [32400, 61200] }
        ]
      },
      "inactivity_period": 604800,
      "team_mention_behavior": "only_active_members",
      "user_reply_behavior": "assign_user",
      "received_reply_behavior": "show_in_assignee_inbox",
      "team_sidebar_behavior": "show_team_space",
      "team_inbox_enabled": true,
      "chat_room_enabled": true
    }
  ]
}
```

{% endcode %}
{% endtab %}
{% endtabs %}

{% code title="Réponse" %}

```json
{
  "teams": [
    {
      "id": "d75aecb6-96a2-4b5f-afa6-19d1916052ea",
      "name": "Support",
      "emoji": ":dart:",
      "color": "#2266ED",
      "organization": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92",
      "active_members": [
        "1ce8117e-ae42-4304-b953-c81656da4bd1",
        "74f91030-39b8-4627-9835-9cfbce9d67c1"
      ],
      "observers": ["a41a00fd-453d-49d7-a487-9765c35a3b70"],
      "business_hours": {
        "tz": "America/Montreal",
        "t": [
          { "d": 1, "s": [32400, 61200] },
          { "d": 2, "s": [32400, 61200] },
          { "d": 3, "s": [32400, 61200] },
          { "d": 4, "s": [32400, 61200] },
          { "d": 5, "s": [32400, 61200] }
        ]
      },
      "inactivity_period": 604800,
      "team_mention_behavior": "only_active_members",
      "user_reply_behavior": "assign_user",
      "received_reply_behavior": "show_in_assignee_inbox",
      "team_sidebar_behavior": "show_team_space",
      "team_inbox_enabled": true,
      "chat_room_enabled": true
    }
  ]
}
```

{% endcode %}

**Attributs**

| Nom (\* obligatoire)      | Description                                                                                                | Exemple                                    |
| ------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
| `name`\*                  | Chaîne du nom de l’équipe                                                                                  | `"Support"`                                |
| `organisation`\*          | Chaîne d’ID de l’Organisation                                                                              | `"0d9bab85-a74f-4ece-9142-0f9b9f36ff92"`   |
| `emoji`                   | Code court d’emoji dans `:name:` format (voir [Emojipedia](https://emojipedia.org/) pour les codes courts) | `":dart:"`                                 |
| `color`                   | [Code couleur HEX](https://en.wikipedia.org/wiki/Web_colors#Hex_triplet)                                   | `"#2266ED"`                                |
| `active_members`          | Tableau de chaînes d’identifiants d’utilisateur pour les membres actifs de l’équipe                        | `["1ce8117e-ae42-4304-b953-c81656da4bd1"]` |
| `observers`               | Tableau de chaînes d’identifiants d’utilisateur pour les observateurs de l’équipe                          | `["a41a00fd-453d-49d7-a487-9765c35a3b70"]` |
| `business_hours`          | Objet de configuration des Heures d’ouverture, voir ci-dessous pour plus de détails                        | `{"tz": "America/Montreal", "t": [...]}`   |
| `inactivity_period`       | Période d’inactivité en secondes avant qu’une conversation soit considérée comme obsolète                  | `604800`                                   |
| `team_mention_behavior`   | Qui reçoit les notifications lorsque l’équipe est mentionnée                                               | `"only_active_members"`                    |
| `user_reply_behavior`     | Ce qui se passe lorsqu’un utilisateur répond à une conversation non assignée                               | `"assign_user"`                            |
| `received_reply_behavior` | Où afficher les conversations assignées lorsqu’une nouvelle réponse est reçue                              | `"show_in_assignee_inbox"`                 |
| `team_sidebar_behavior`   | Ce qu’il faut afficher dans la barre latérale pour cette équipe                                            | `"show_team_space"`                        |
| `team_inbox_enabled`      | Indique si la Boîte d’équipe est activée                                                                   | `vrai`                                     |
| `chat_room_enabled`       | Indique si le Salon de discussion de l’équipe est activé                                                   | `vrai`                                     |

`Membres actifs, observateurs`

Les Membres actifs reçoivent des notifications pour les nouveaux messages dans la Boîte d’équipe et voient aussi les conversations dans la vue unifiée Boîtes d’équipe. Les observateurs ne reçoivent pas de notifications pour les nouveaux messages dans la Boîte d’équipe et ne voient pas les conversations dans la vue unifiée Boîtes d’équipe, mais ils peuvent ouvrir et gérer la Boîte d’équipe au besoin. Tous deux ont accès aux contacts, aux Réponses, aux Calendriers et aux Intégrations partagés avec l’équipe.

`business_hours`

Le `business_hours` L’objet définit quand l’équipe est disponible :

* `tz`: Identifiant de fuseau horaire (voir [liste des fuseaux horaires](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List))
* `t`: Tableau d’objets de créneau horaire, chacun contenant :
  * `d`: Jour de la semaine (0 = dimanche, 1 = lundi, ..., 6 = samedi)
  * `s`: Tableau de deux entiers représentant les heures de début et de fin en secondes depuis minuit (par ex., `[32400, 61200]` = de 9 h à 17 h)

`inactivity_period`

Le nombre de secondes d’inactivité après lequel une conversation est considérée comme obsolète. Valeurs courantes : `86400` (1 jour), `259200` (3 jours), `604800` (1 semaine).

`team_mention_behavior`

* `all_members`: Tous les membres de l’équipe (actifs et observateurs) reçoivent des notifications lorsque l’équipe est mentionnée
* `only_active_members`: Seuls les membres actifs reçoivent des notifications lorsque l’équipe est mentionnée

`user_reply_behavior`

* `assign_user`: Assigner automatiquement l’utilisateur à la conversation lorsqu’il répond
* `leave_in_team_inbox`: Laisser la conversation dans la Boîte d’équipe sans l’assigner

`received_reply_behavior`

* `show_in_assignee_inbox`: Afficher dans la boîte de réception du responsable lorsqu’une nouvelle réponse est reçue
* `show_in_team_inbox`: Replacer dans la Boîte d’équipe lorsqu’une nouvelle réponse est reçue

`team_sidebar_behavior`

* `show_team_space`: Afficher l’espace d’équipe complet dans la barre latérale
* `show_team_inbox`: Afficher uniquement la Boîte d’équipe dans la barre latérale

### Mettre à jour des équipe(s)

`PATCH /v1/teams/:id1,:id2,:id3,...`

Mettre à jour une ou plusieurs équipes. Le API token doit appartenir à un administrateur ou au propriétaire de l’Organisation.

Une requête réussie renverra les équipes mises à jour.

{% code title="payload de la requête" %}

```json
{
  "teams": [
    {
      "id": "d75aecb6-96a2-4b5f-afa6-19d1916052ea",
      "name": "Customer Support",
      "emoji": ":zap:",
      "active_members": [
        "1ce8117e-ae42-4304-b953-c81656da4bd1",
        "74f91030-39b8-4627-9835-9cfbce9d67c1"
      ]
    }
  ]
}
```

{% endcode %}

**Attributs**

Équipe `id` est requis. Consultez la section Créer une ou plusieurs équipes pour les autres attributs. Vous pouvez transmettre uniquement les attributs que vous voulez mettre à jour. Dans l’exemple ci-dessus, seuls le nom, l’emoji et les Membres actifs seront mis à jour.

**Propriétés de l’équipe**

La même structure est renvoyée par [Lister les équipes](#list-teams), [Créer des équipe(s)](#create-team-s), et [Mettre à jour des équipe(s)](#update-team-s).

| Nom (\* toujours présent)   | Description                                                                               |
| --------------------------- | ----------------------------------------------------------------------------------------- |
| `id`\*                      | UUID de l’équipe                                                                          |
| `name`\*                    | Nom de l’équipe                                                                           |
| `organisation`\*            | UUID de l’Organisation                                                                    |
| `active_members`\*          | Tableau des UUID des utilisateurs pour les membres actifs de l’équipe                     |
| `observers`\*               | Tableau des UUID des utilisateurs pour les observateurs de l’équipe                       |
| `emoji`                     | Code court de l’emoji (par ex. `:dart:`)                                                  |
| `color`                     | Code couleur HEX                                                                          |
| `business_hours`            | Objet de configuration des Heures d’ouverture                                             |
| `inactivity_period`         | Période d’inactivité en secondes avant qu’une conversation soit considérée comme obsolète |
| `team_inbox_enabled`\*      | Indique si la Boîte d’équipe est activée                                                  |
| `chat_room_enabled`\*       | Indique si le Salon de discussion de l’équipe est activé                                  |
| `team_mention_behavior`\*   | `only_active_members` ou `all_members`                                                    |
| `user_reply_behavior`\*     | `assign_user` ou `leave_in_team_inbox`                                                    |
| `received_reply_behavior`\* | `show_in_assignee_inbox` ou `show_in_team_inbox`                                          |
| `team_sidebar_behavior`\*   | `show_team_space` ou `show_team_inbox`                                                    |

***

## Utilisateurs

Les endpoints utilisateur vous permettent de lister les Utilisateurs de votre organisation.

{% hint style="info" %}
Le statut de l’utilisateur (disponibilité, absent, Absent du bureau) n’est pas disponible via l’API. Il n’existe actuellement aucun endpoint pour récupérer ou mettre à jour le statut de l’utilisateur.
{% endhint %}

### Lister les Utilisateurs

`GET /v1/users`

Lister les Utilisateurs dans les Organisations dont l’utilisateur authentifié fait partie.

{% code title="Réponse" %}

```json
{
  "Utilisateurs": [
    {
      "id": "a41a00fd-453d-49d7-a487-9765c35a3b70",
      "me": true,
      "email": "philippe@missiveapp.com",
      "name": "Philippe Lehoux",
      "avatar_url": "https://..."
    }
  ]
}
```

{% endcode %}

**Paramètres**

| Nom (\* obligatoire) | Par défaut | Description                                             |
| -------------------- | ---------- | ------------------------------------------------------- |
| `organisation`       | `null`     | ID de l’Organisation                                    |
| `limit`              | `50`       | Nombre d’utilisateurs renvoyés. Valeur maximale : `200` |
| `offset`             | `0`        | Décalage utilisé pour la pagination.                    |

**Propriétés utilisateur**

| Nom (\* toujours présent) | Description                                                                |
| ------------------------- | -------------------------------------------------------------------------- |
| `id`\*                    | UUID de l’utilisateur                                                      |
| `name`\*                  | Nom affiché de l’utilisateur                                               |
| `e-mail`\*                | E-mail de l’utilisateur                                                    |
| `avatar_url`\*            | URL de l’avatar de l’utilisateur                                           |
| `me`                      | `vrai` lorsque l’utilisateur est le propriétaire du API token ; omis sinon |

***

## Tâches

Les endpoint de tâches vous permettent de créer et de gérer des tâches par programmation.

Exemple d’utilisation : créez automatiquement des tâches à partir de votre outil de Gestion de projet ou de votre traqueur de bugs.

### Lister les tâches

`GET /v1/tasks`

Listez les tâches auxquelles l’utilisateur authentifié a accès. Les résultats sont classés par date de dernière activité (les plus récents d’abord) et peuvent être filtrés selon divers critères.

Exemple de requête :

```
GET /v1/tasks?organization=0d9bab85-a74f-4ece-9142-0f9b9f36ff92&state=todo&limit=10
```

{% code title="Réponse" %}

```json
{
  "tasks": [
    {
      "id": "75ad834a-9bd6-4008-b9e6-fc9fa2e7770b",
      "conversation": null,
      "title": "Relire la pull request",
      "description": "Veuillez relire la PR #123",
      "state": "todo",
      "started_at": null,
      "closed_at": null,
      "assignees": ["1ce8117e-ae42-4304-b953-c81656da4bd1"],
      "team": "0e24f298-965d-4475-9220-b32636a1e2c3",
      "due_at": 1692371867,
      "type": "task",
      "last_activity_at": 1692371900
    },
    {
      "id": "a5d2aa1c-3828-4f90-bbd8-3dffaadda97e",
      "conversation": null,
      "title": "Follow up with client",
      "description": null,
      "state": "in_progress",
      "started_at": 1692371000,
      "closed_at": null,
      "assignees": ["74f91030-39b8-4627-9835-9cfbce9d67c1"],
      "team": null,
      "due_at": null,
      "type": "conversation",
      "last_activity_at": 1692371800
    }
  ]
}
```

{% endcode %}

**Paramètres de requête**

| Nom            | Description                                                                                       | Exemple                                  |
| -------------- | ------------------------------------------------------------------------------------------------- | ---------------------------------------- |
| `limit`        | Nombre de tâches à renvoyer (min 2, max 50)                                                       | `10`                                     |
| `jusqu’à`      | Horodatage Unix pour la pagination, renvoie les tâches avec last\_activity\_at avant cette valeur | `1692371867`                             |
| `organisation` | Filtrer par ID d’Organisation                                                                     | `"0d9bab85-a74f-4ece-9142-0f9b9f36ff92"` |
| `team`         | Filtrer par ID d’équipe                                                                           | `"0e24f298-965d-4475-9220-b32636a1e2c3"` |
| `assignee`     | Filtrer par ID utilisateur du responsable                                                         | `"1ce8117e-ae42-4304-b953-c81656da4bd1"` |
| `state`        | Filtrer par état. L’une des valeurs suivantes : `todo`, `in_progress`, `terminées`                | `"todo"`                                 |
| `type`         | Filtrer par type. L’un des éléments suivants : `tâche`, `conversation`, `tous`                    | `"all"`                                  |
| `conversation` | Filtrer par l’ID de la conversation parente (renvoie les sous-tâches de cette conversation)       | `"a5d2aa1c-3828-4f90-bbd8-3dffaadda97e"` |
| `due_at_gteq`  | Filtrer les tâches avec `due_at` supérieur ou égal à cet horodatage Unix                          | `1692371867`                             |
| `due_at_lteq`  | Filtrer les tâches avec `due_at` inférieur ou égal à cet horodatage Unix                          | `1692400000`                             |

`type`

Filtrer les tâches par leur type :

* `tâche` - Ne renvoyer que les tâches (sous-tâches de conversation ou tâches autonomes)
* `conversation` - Ne renvoyer que les conversations avec tâche (conversations assignées ou avec échéance)
* `tous` - Renvoyer à la fois les tâches et les conversations avec tâche (par défaut)

Pagination

Pour paginer les résultats, utilisez le `last_activity_at` la valeur de la dernière tâche dans la réponse comme `jusqu’à` paramètre de la requête suivante. Soustrayez 1 au timestamp pour éviter les doublons, car `jusqu’à` est inclusif.

**Propriétés de la tâche**

La même structure est renvoyée par [Lister les tâches](#list-tasks), [Obtenir une tâche](#get-a-task), [Créer une tâche](#create-a-task), et [Mettre à jour une tâche](#update-a-task), et est aussi intégré en tant que `tâche` champ dans un commentaire.

| Nom (\* toujours présent) | Description                                                                                                                  |
| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `id`\*                    | UUID de la tâche                                                                                                             |
| `titre`\*                 | Titre de la tâche                                                                                                            |
| `state`\*                 | `todo`, `in_progress`, ou `terminées`                                                                                        |
| `type`\*                  | `tâche` ou `conversation`                                                                                                    |
| `conversation`            | UUID de la conversation parente pour les sous-tâches                                                                         |
| `description`             | Description de la tâche                                                                                                      |
| `due_at`                  | Horodatage Unix correspondant à la date d’échéance de la tâche                                                               |
| `started_at`              | Horodatage Unix correspondant au début du travail                                                                            |
| `closed_at`               | Horodatage Unix correspondant au moment où la tâche a été terminée                                                           |
| `assignees`\*             | Tableau des responsables. UUID dans List/Create/Update ; objets utilisateur complets dans Get a task et sur les commentaires |
| `team`                    | Équipe. UUID dans List/Create/Update ; objet équipe complet dans Get a task et sur les commentaires                          |
| `last_activity_at`        | Horodatage Unix de la dernière activité. Inclus uniquement dans [Lister les tâches](#list-tasks)                             |

### Obtenir une tâche

`GET /v1/tasks/:id`

Obtenez une tâche unique par ID. Renvoie la tâche avec tous les détails, y compris les responsables et les informations sur l’équipe.

{% code title="Réponse" %}

```json
{
  "tasks": {
    "id": "75ad834a-9bd6-4008-b9e6-fc9fa2e7770b",
    "conversation": null,
    "title": "Relire la pull request",
    "description": "Veuillez relire la PR #123",
    "state": "todo",
    "started_at": null,
    "closed_at": null,
    "assignees": [
      {
        "id": "1ce8117e-ae42-4304-b953-c81656da4bd1",
        "name": "John Doe",
        "email": "john@example.com",
        "avatar_url": "https://..."
      }
    ],
    "team": {
      "id": "0e24f298-965d-4475-9220-b32636a1e2c3",
      "name": "Engineering",
      "Organisation": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92"
    },
    "due_at": 1692371867,
    "type": "task"
  }
}
```

{% endcode %}

Le `assignees` le tableau contient des objets utilisateur complets avec `id`, `name`, `e-mail`, et `avatar_url`. Le `team` l’objet contient des informations complètes sur l’équipe avec `id`, `name`, et `organisation`.

### Créer une tâche

`POST /v1/tasks`

Créez une nouvelle tâche. Les tâches peuvent être autonomes, liées à des conversations ou créées au sein de conversations.

{% hint style="info" %}
Les tâches créées via l’API apparaissent dans la **Tâches** en lecture seule, pas dans la boîte de réception. La création d’une tâche ne suit pas automatiquement la conversation parente pour le propriétaire du API token.

Lorsque vous créez des sous-tâches dans des conversations, vous pouvez suivre automatiquement la conversation parente. Pour désactiver cela, allez dans **Paramètres > Préférences** et recherchez « watch » pour trouver et désactiver l’ **option de suivi automatique à la création d’une tâche** option.
{% endhint %}

{% tabs %}
{% tab title="Tâche indépendante" %}
{% code title="payload de la requête" %}

```json
{
  "tasks": {
    "organization": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92",
    "title": "Relire la pull request",
    "description": "Veuillez relire la PR #123",
    "team": "0e24f298-965d-4475-9220-b32636a1e2c3",
    "due_at": 1692371867
  }
}
```

{% endcode %}
{% endtab %}

{% tab title="Sous-tâche" %}
{% code title="payload de la requête" %}

```json
{
  "tasks": {
    "organization": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92",
    "title": "Follow up with client",
    "description": "Discuss proposal details",
    "assignees": ["1ce8117e-ae42-4304-b953-c81656da4bd1"],
    "conversation": "a5d2aa1c-3828-4f90-bbd8-3dffaadda97e",
    "subtask": true,
    "add_users": ["74f91030-39b8-4627-9835-9cfbce9d67c1"]
  }
}
```

{% endcode %}
{% endtab %}
{% endtabs %}

{% code title="Réponse" %}

```json
{
  "tasks": {
    "id": "75ad834a-9bd6-4008-b9e6-fc9fa2e7770b",
    "conversation": null,
    "title": "Titre de tâche mis à jour",
    "description": "Nouvelle description",
    "state": "in_progress",
    "assignees": ["1ce8117e-ae42-4304-b953-c81656da4bd1"],
    "team": "0e24f298-965d-4475-9220-b32636a1e2c3",
    "due_at": 1692371867
  }
}
```

{% endcode %}

**Paramètres**

| Nom (\* obligatoire)              | Description                                                                                                                          | Exemple                                    |
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------ |
| `titre`\*                         | Titre de la tâche (1000 caractères maximum)                                                                                          | `« Relire la pull request »`               |
| `description`                     | Description de la tâche (10 000 caractères max)                                                                                      | `"Veuillez examiner la PR #123"`           |
| `state`                           | État de la tâche. L’un des suivants : `todo`, `in_progress`, `terminées`                                                             | `"in_progress"`                            |
| `organisation`                    | Chaîne d’ID de l’Organisation (obligatoire lors de l’utilisation de team, assignees ou add\_users)                                   | `"0d9bab85-a74f-4ece-9142-0f9b9f36ff92"`   |
| `team`                            | Chaîne d’ID d’équipe (l’équipe ou les responsables sont requis pour les tâches autonomes)                                            | `"0e24f298-965d-4475-9220-b32636a1e2c3"`   |
| `assignees`                       | Tableau de chaînes d’ID utilisateur (l’un des champs team ou assignees est requis pour les tâches autonomes)                         | `["1ce8117e-ae42-4304-b953-c81656da4bd1"]` |
| `due_at`                          | Horodatage Unix pour la Date d’échéance de la tâche                                                                                  | `1692371867`                               |
| `sous-tâche`                      | Booléen indiquant s’il s’agit d’une sous-tâche d’une conversation                                                                    | `vrai`                                     |
| `conversation`                    | Chaîne d’ID de la conversation parente (obligatoire lorsque subtask est true)                                                        | `"a5d2aa1c-3828-4f90-bbd8-3dffaadda97e"`   |
| `references`                      | Tableau de chaînes pour rechercher ou créer la conversation parente (utilisé lors de la création d’une sous-tâche)                   | `["<some-reference-123>"]`                 |
| `conversation_subject`            | Objet de la conversation parente lors de la création via des références                                                              | `"Nouvelle demande de fonctionnalité"`     |
| `ajouter_des_utilisateurs`        | Tableau des ID utilisateur à ajouter à la conversation parente (uniquement pour les sous-tâches)                                     | `["74f91030-39b8-4627-9835-9cfbce9d67c1"]` |
| `ajouter_à_la_boîte_de_réception` | Déplacer la conversation parente dans la boîte de réception pour tous les utilisateurs ayant accès (uniquement pour les sous-tâches) | `vrai`                                     |

### Mettre à jour une tâche

`PATCH /v1/tasks/:id`

Met à jour les attributs d’une tâche existante.

{% code title="payload de la requête" %}

```json
{
  "tasks": {
    "title": "Titre de tâche mis à jour",
    "description": "Nouvelle description",
    "state": "in_progress",
    "assignees": ["1ce8117e-ae42-4304-b953-c81656da4bd1"],
    "team": "0e24f298-965d-4475-9220-b32636a1e2c3",
    "due_at": 1692371867
  }
}
```

{% endcode %}

**Paramètres**

| Nom           | Description                                                              | Exemple                                    |
| ------------- | ------------------------------------------------------------------------ | ------------------------------------------ |
| `titre`       | Titre de la tâche (1000 caractères maximum)                              | `"Titre de la tâche mis à jour"`           |
| `description` | Description de la tâche (10 000 caractères max)                          | `"Nouvelle description"`                   |
| `state`       | État de la tâche. L’un des suivants : `todo`, `in_progress`, `terminées` | `"in_progress"`                            |
| `assignees`   | Array de chaînes d’ID utilisateur                                        | `["1ce8117e-ae42-4304-b953-c81656da4bd1"]` |
| `team`        | Chaîne d’ID d’équipe                                                     | `"0e24f298-965d-4475-9220-b32636a1e2c3"`   |
| `due_at`      | Horodatage Unix pour la Date d’échéance de la tâche                      | `1692371867`                               |

`titre`

Le titre de la tâche qui sera affiché dans la liste des tâches et les détails de la tâche. Limité à 1000 caractères.

`description`

Une description plus longue de la tâche qui fournit un contexte ou des détails supplémentaires. La description prend en charge le texte brut et est limitée à 10000 caractères.

`state`

L’état actuel de la tâche. Peut être l’un des suivants :

* `todo` - La tâche est en attente et doit être traitée
* `in_progress` - La tâche est en cours de traitement
* `terminées` - La tâche a été terminée ou marquée comme terminée

Si non précisé, les nouvelles tâches prennent par défaut `todo` l’état.

`organisation`

L’ID de l’organisation est requis lors de l’assignation de tâches à des équipes ou à des utilisateurs via `team`, `assignees`, ou `ajouter_des_utilisateurs` des paramètres. Cela garantit que la tâche est créée dans le bon contexte organisationnel.

`team`

Pour les tâches autonomes (pas les sous-tâches), l’un ou l’autre `team` ou `assignees` doit être spécifié. Lorsqu’une équipe est assignée, tous les membres de l’équipe auront accès à la tâche et elle apparaîtra dans la liste des tâches de l’équipe.

`assignees`

Pour les tâches autonomes (pas les sous-tâches), l’un ou l’autre `team` ou `assignees` doit être spécifié. Lorsque des utilisateurs sont assignés, ils seront responsables de terminer la tâche et elle apparaîtra dans leurs listes de tâches personnelles.

`due_at`

Définit une date d’échéance pour la tâche à l’aide d’un timestamp Unix. La tâche sera marquée en retard si elle n’est pas terminée à cette date. La définition de ce champ est facultative.

`sous-tâche`

Lorsque `vrai`, indique que cette tâche doit être créée comme une sous-tâche dans une conversation. Les sous-tâches nécessitent soit un `conversation` ID ou `references` pour identifier la conversation parente.

`conversation`

Requis lors de la création d’une sous-tâche (`subtask: true`). Spécifie l’ID de la conversation existante où la sous-tâche doit être créée.

`references`

Une alternative à `conversation` lors de la création de sous-tâches. Permet de trouver ou de créer la conversation parente à l’aide de références de message (comme les Message-ID d’e-mail). Si plusieurs conversations correspondent aux références, la tâche sera créée dans la première conversation correspondante.

`conversation_subject`

Lors de la création d’une sous-tâche à l’aide de `references` et qu’une nouvelle conversation doit être créée, ce champ définit l’objet de cette nouvelle conversation.

`ajouter_des_utilisateurs`

Lors de la création de sous-tâches, ce paramètre vous permet d’ajouter des utilisateurs supplémentaires à la conversation parente. Ces utilisateurs auront accès à la fois à la conversation et à la sous-tâche. Le `organisation` paramètre est requis lors de l’utilisation de `ajouter_des_utilisateurs`.

`ajouter_à_la_boîte_de_réception`

Lors de la création de sous-tâches, transmettez `add_to_inbox: true` pour déplacer la conversation parente vers la boîte de réception pour tout le monde ayant accès. Sans cela, la conversation n’apparaîtra dans la boîte de réception de personne à la suite de la création de la tâche.

***

## Hooks

Exemple d’utilisation : déclenchez automatiquement des workflows dans des systèmes externes lorsque de nouveaux messages arrivent ou que des commentaires sont ajoutés.

### Créer un webhook

`POST /v1/hooks`

Créez un abonnement webhook pour recevoir des notifications pour des événements spécifiques dans Missive. Cet endpoint permet une intégration avec des services comme Zapier, n8n et d’autres, ou peut être utilisé directement pour des intégrations personnalisées. En coulisses, cet endpoint crée une règle Missive avec une action webhook - vous pourrez ensuite voir et modifier ces règles dans les paramètres de vos règles Missive, comme toute autre règle que vous créez manuellement.

{% code title="payload de la requête" %}

```json
{
  "hooks": {
    "type": "new_comment",
    "url": "https://hooks.example.com/callback",
    "organization": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92",
    "is_task": true,
    "author": "user_id",
    "mention": "mentioned_user_id",
    "content_contains": "search text",
    "content_starts_with": "prefix",
    "content_ends_with": "suffix"
  }
}
```

{% endcode %}

{% code title="Réponse" %}

```json
{
  "hooks": {
    "id": "d75aecb6-96a2-4b5f-afa6-19d1916052ea"
  }
}
```

{% endcode %}

**Paramètres**

| Nom (\* obligatoire)        | Par défaut | Description                                                                                                                                                                                                    |
| --------------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` \*                   |            | Type d’événement auquel s’abonner. Valeurs prises en charge : incoming\_email, incoming\_sms\_message, incoming\_facebook\_message, incoming\_whatsapp\_message, incoming\_twilio\_chat\_message, new\_comment |
| `url` \*                    |            | L’URL du webhook qui recevra les notifications d’événements                                                                                                                                                    |
| `organisation`              | `null`     | ID d’organisation. Si non fourni, crée un abonnement webhook personnel                                                                                                                                         |
| `content_contains`          | `null`     | Déclenchez uniquement lorsque le contenu contient ce texte                                                                                                                                                     |
| `content_starts_with`       | `null`     | Déclenchez uniquement lorsque le contenu commence par ce texte                                                                                                                                                 |
| `content_ends_with`         | `null`     | Déclenchez uniquement lorsque le contenu se termine par ce texte                                                                                                                                               |
| Réservé à `new_comment`:    |            |                                                                                                                                                                                                                |
| `is_task`                   | `faux`     | Déclenchez uniquement pour les commentaires de tâche                                                                                                                                                           |
| `author`                    | `null`     | Déclenchez uniquement pour les commentaires de cet ID utilisateur                                                                                                                                              |
| `mention`                   | `null`     | Déclenchez uniquement lorsque cet ID utilisateur est mentionné                                                                                                                                                 |
| Réservé à `incoming_email`: |            |                                                                                                                                                                                                                |
| `from_eq`                   | `null`     | Déclenchez uniquement pour les messages provenant de cette adresse e-mail exacte                                                                                                                               |
| `subject_contains`          | `null`     | Ne déclenche que pour les messages contenant ce texte dans l’objet                                                                                                                                             |

### Supprimer le webhook

`DELETE /v1/hooks/:id`

Supprimez un abonnement webhook. En coulisses, cela supprime la règle contenant l’action webhook.

Dernière mise à jour le 18 septembre 2025

***

Besoin de réponses plus précises ?\\


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://missiveapp.com/docs/developers/fr/rest-api/endpoints.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
