> 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/de/rest-api/endpoints.md).

# Endpunkte

Vollständige Referenz für Missive API-Endpunkte: Statistiken, Unterhaltungen, Entwürfe, Beiträge, Kontakte, Labels und mehr.

## Statistiken

Statistiken-Endpunkte ermöglichen es Ihnen, einen Bericht auf Grundlage eines ausgewählten Zeitraums und optionaler Filter wie Team-Posteingang, Nutzer, Labels usw. abzurufen. Aufgrund der asynchronen Natur der Berichtserstellung sind zwei Endpunkte beteiligt: eine Anfrage, um den Bericht zu erstellen, und eine weitere, um die Daten kurz danach abzurufen.

{% hint style="info" %}
Statistiken-API-Endpunkte erfordern einen Productive- oder Business-Plan. Filterfunktionen (Teams, Nutzer, Labels, Konten) erfordern einen Business-Plan.
{% endhint %}

Beispielverwendung: Statistiken automatisch mit Ihrem Business-Intelligence-Tool synchronisieren.

### Statistikenbericht erstellen

`POST /v1/analytics/reports`

{% tabs %}
{% tab title="Einfach" %}
{% code title="Anfrage-Payload" %}

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

{% endcode %}
{% endtab %}

{% tab title="Mit Filtern" %}
{% code title="Anfrage-Payload" %}

```json
{
  "reports": {
    "Organisation": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92",
    "start": 1691812800,
    "end": 1692371867,
    "time_zone": "America/Montreal",
    "teams": [
      "0e24f298-965d-4475-9220-b32636a1e2c3"
    ],
    "Nutzer": [
      "1ce8117e-ae42-4304-b953-c81656da4bd1",
      "74f91030-39b8-4627-9835-9cfbce9d67c1"
    ],
    "Konten": [
      "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="Vorlage" %}

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

{% endcode %}

Diese ID muss dann in eine [Bericht anfordern](#get-analytics-report).

**Parameter**

| Name (\* erforderlich) | Beschreibung                                                                                      | Beispiel                                   |
| ---------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------ |
| `Organisation`\*       | Organisations-ID-String                                                                           | `"0d9bab85-a74f-4ece-9142-0f9b9f36ff92"`   |
| `Start`\*              | Beginn des Berichtszeitraums                                                                      | `1691812800`                               |
| `end`\*                | Ende des Berichtszeitraums                                                                        | `1692371867`                               |
| `time_zone`            | Zeitzonenkennung ( [Referenz](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)) | `"America/Montreal"`                       |
| `Teams`                | Array von Team-ID-Strings                                                                         | `["0e24f298-965d-4475-9220-b32636a1e2c3"]` |
| `Nutzer`               | Array von Benutzer-ID-Strings                                                                     | `["1ce8117e-ae42-4304-b953-c81656da4bd1"]` |
| `geteilte Labels`      | Array von Zeichenfolgen für Label der Organisation-IDs                                            | `["bca0bb8f-8b2f-45f8-a59a-333de84f0184"]` |
| `Konten`               | Array von Konto-ID-Strings                                                                        | `["716be7a6-fd40-45a2-bfcb-43b9ed38d1f0"]` |
| `account_types`        | Array von Strings                                                                                 | `["E-Mail", "SMS"]`                        |

`Teams, Nutzer, shared_labels, Konten`\
Siehe [Ressourcen-IDs](https://missiveapp.com/docs/developers/de/rest-api.md#resource-ids).

`account_types`\
`„benutzerdefiniert“`, `„E-Mail“`, `"Instagram"`, `"live_chat"`, `„Messenger“`, `"SMS"`, `"WhatsApp"`

### Statistikenbericht abrufen

`GET /v1/Statistiken/reports/:id`

Rufen Sie einen Bericht mithilfe seiner id ab, die von einer Create report-Anfrage zurückgegeben wurde. Die Berichtsdaten werden als JSON zurückgegeben.

Die meisten Berichte sind innerhalb von 2 oder 3 Sekunden nach der Erstellung abgeschlossen, einige können jedoch 30 Sekunden oder länger dauern. Sie laufen 60 Sekunden nach Abschluss ab. Für unvollständige, abgelaufene oder nicht vorhandene Berichte wird eine leere 404-Antwort zurückgegeben.

{% hint style="info" %}
Rufen Sie einen Bericht 5 Sekunden nach seiner Erstellung ab und versuchen Sie es alle 5 Sekunden erneut, bis eine erfolgreiche 200-Antwort zurückgegeben wird.
{% endhint %}

***

## Kontakte

Kontakt-Endpunkte ermöglichen es Ihnen, Ihre Kontakte programmgesteuert zu verwalten.

Beispielverwendung: Kontakte zwischen Missive und Ihrem CRM automatisch synchronisieren.

### Kontakte erstellen

`POST /v1/contacts`

{% code title="Anfrage-Payload" %}

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

{% endcode %}

Eine erfolgreiche Anfrage gibt neu erstellte Kontakte zurück.

{% code title="Vorlage" %}

```json
{
  "Kontakte": [
    {
      "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": "Privat",
          "value": "philippe@missiveapp.com"
        },
        {
          "kind": "phone_number",
          "label": "Mobil",
          "value": "+1 518 777-7777"
        }
      ],
      "memberships": [
        {
          "title": "CEO",
          "location": "Québec city",
          "group": {
            "id": "f8905b6f-2d13-466a-a2e6-8e3de090a6d1",
            "kind": "Organisation",
            "name": "Missive"
          }
        }
      ]
    }
  ]
}
```

{% endcode %}

**Attribute**

| Name (\* erforderlich) | Beschreibung                                                      | Beispiel                                                                      |
| ---------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `contact_book`\*       | Adressbuch-ID-Zeichenfolge                                        | `"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“`                                                           |
| `prefix`               | string                                                            | `„Herr“`                                                                      |
| `Namenszusatz`         | string                                                            | `„Jr.“`                                                                       |
| `Spitzname`            | string                                                            | `„Phil“`                                                                      |
| `file_as`              | string                                                            | `„Missive“`                                                                   |
| `notes`                | string                                                            | `Toller Interessent!`                                                         |
| `Markiert`             | boolean                                                           | `true`                                                                        |
| `Geschlecht`           | string                                                            | `„Männlich“`                                                                  |
| `Infos`                | Array mit Kontaktinformationsobjekten, Details siehe unten        | `[{"kind": "email", "label": "work", "value": "phil@missiveapp.com"}]`        |
| `Mitgliedschaften`     | Array mit Kontaktmitgliedschaftsobjekten, siehe unten für Details | `[{ "title": "CEO", "group": { "kind": "organization", "name": "Missive" }}]` |

`Infos`

Die `Infos` array ermöglicht es Ihnen, Daten verschiedener Arten einem Kontakt zuzuordnen: `email`, `twitter`, `phone_number`, `facebook`, `physical_address`, `url`, `custom`.

Infos mit kind `email`

| Name (\* erforderlich) | Beschreibung                                                                          | Beispiel                    |
| ---------------------- | ------------------------------------------------------------------------------------- | --------------------------- |
| `kind`\*               | string                                                                                | `„E-Mail“`                  |
| `value`\*              | E-Mail-Adresse                                                                        | `"philippe@missiveapp.com"` |
| `Label`\*              | Typ der E-Mail-Adresse. Zulässige Werte: `privat`, `Arbeit`, `persönlich`, `sonstige` | `„work“`                    |
| `custom_label`         | Benutzerdefinierter Label-Wert, nur verwenden, wenn `Label` ist `sonstige`            | `„old“`                     |

Infos mit kind `phone_number`

| Name (\* erforderlich) | Beschreibung                                                                                                                                 | Beispiel            |
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
| `kind`\*               | string                                                                                                                                       | `„phone_number“`    |
| `value`\*              | Telefonnummer                                                                                                                                | `"+1 518 777-7777"` |
| `Label`\*              | Typ der Telefonnummer. Zulässige Werte: `Hauptnummer`, `Mobil`, `privat`, `Arbeit`, `home_fax`, `work_fax`, `other_fax`, `Pager`, `sonstige` | `„mobile“`          |
| `custom_label`         | Benutzerdefinierter Label-Wert, nur verwenden, wenn `Label` ist `sonstige`                                                                   | `„old“`             |

Infos mit kind `twitter`

| Name (\* erforderlich) | Beschreibung                                                               | Beispiel     |
| ---------------------- | -------------------------------------------------------------------------- | ------------ |
| `kind`\*               | string                                                                     | `„twitter“`  |
| `value`\*              | Twitter-Benutzername                                                       | `„@plehoux“` |
| `Label`\*              | Twitter-Kontotyp. Zulässige Werte: `Arbeit`, `persönlich`, `sonstige`      | `„personal“` |
| `custom_label`         | Benutzerdefinierter Label-Wert, nur verwenden, wenn `Label` ist `sonstige` | `„old“`      |

Infos mit kind `facebook`

| Name (\* erforderlich) | Beschreibung                                                               | Beispiel                    |
| ---------------------- | -------------------------------------------------------------------------- | --------------------------- |
| `kind`\*               | string                                                                     | `„facebook“`                |
| `name`\*               | Facebook-Benutzername                                                      | `„Philippe-Antoine Lehoux“` |
| `Label`\*              | Facebook-Kontotyp. Zulässige Werte: `Arbeit`, `persönlich`, `sonstige`     | `„personal“`                |
| `custom_label`         | Benutzerdefinierter Label-Wert, nur verwenden, wenn `Label` ist `sonstige` | `„old“`                     |

Infos mit kind `physical_address`

| Name (\* erforderlich) | Beschreibung                                                               | Beispiel             |
| ---------------------- | -------------------------------------------------------------------------- | -------------------- |
| `kind`\*               | string                                                                     | `„physical_address“` |
| `Straße`               | string                                                                     | `123 Fake Street`    |
| `extended_address`     | string                                                                     | `Büro 222`           |
| `Stadt`                | string                                                                     | `Quebec`             |
| `Region`               | string                                                                     | `QC`                 |
| `postal_code`          | string                                                                     | `G1K 3T4`            |
| `po_box`               | string                                                                     | `PO#12345`           |
| `Land`                 | string                                                                     | `Kanada`             |
| `Label`\*              | Adresstyp. Zulässige Werte: `Arbeit`, `privat`, `sonstige`                 | `„work“`             |
| `custom_label`         | Benutzerdefinierter Label-Wert, nur verwenden, wenn `Label` ist `sonstige` | `„old“`              |

Infos mit kind `url`

| Name (\* erforderlich) | Beschreibung                                                                                 | Beispiel                    |
| ---------------------- | -------------------------------------------------------------------------------------------- | --------------------------- |
| `kind`\*               | string                                                                                       | `„url“`                     |
| `value`\*              | URL                                                                                          | `„https://missiveapp.com/“` |
| `Label`\*              | URL-Typ. Zulässige Werte: `Startseite`, `Profil`, `blog`, `Arbeit`, `persönlich`, `sonstige` | `"homepage"`                |
| `custom_label`         | Benutzerdefinierter Label-Wert, nur verwenden, wenn `Label` ist `sonstige`                   | `"admin"`                   |

Infos mit kind `custom`

| Name (\* erforderlich) | Beschreibung                                              | Beispiel              |
| ---------------------- | --------------------------------------------------------- | --------------------- |
| `kind`\*               | string                                                    | `„benutzerdefiniert“` |
| `value`\*              | string                                                    | `"A custom value"`    |
| `Label`\*              | Benutzerdefinierter Info-Typ. Zulässige Werte: `sonstige` | `"other"`             |
| `custom_label`         | Benutzerdefinierter Label-Wert                            | `„benutzerdefiniert“` |

`Mitgliedschaften`

Die `Mitgliedschaften` array ermöglicht es Ihnen, einen Kontakt mit Organisationen oder Gruppen zu verknüpfen. Eine Mitgliedschaft bettet immer eine zugehörige `Gruppe`, die eine `kind` gleich einem von beiden `Gruppe` oder `Organisation`.

* Organisationen werden meist verwendet, um Kontakte mit ihrem Arbeitsort zu verknüpfen.
* Gruppen werden verwendet, um Kontakte zusammenzufassen. Betrachten Sie Gruppen als Labels.

| Name (\* erforderlich) | Beschreibung                                                     | Beispiel                                      |
| ---------------------- | ---------------------------------------------------------------- | --------------------------------------------- |
| `Abteilung`            | kann festgelegt werden, wenn `Gruppe` ist vom Typ `Organisation` | `„Finanzen“`                                  |
| `title`                | kann festgelegt werden, wenn `Gruppe` ist vom Typ `Organisation` | `„CFO“`                                       |
| `Standort`             | kann festgelegt werden, wenn `Gruppe` ist vom Typ `Organisation` | `„Montreal“`                                  |
| `description`          | kann festgelegt werden, wenn `Gruppe` ist vom Typ `Organisation` | `„Reporting bearbeiten“`                      |
| `Gruppe`\*             | Objekt, siehe unten für Details                                  | `{"kind": "organization", "name": "Missive"}` |

`memberships.group`

| Name (\* erforderlich) | Beschreibung                                          | Beispiel         |
| ---------------------- | ----------------------------------------------------- | ---------------- |
| `kind`\*               | Gruppentyp. Zulässige Werte: `Organisation`, `Gruppe` | `"Organisation"` |
| `name`\*               | string                                                | `„Missive“`      |

**Kontakteigenschaften**

Die gleiche Form wird von [Kontakte erstellen](#create-contact-s), [Kontakt(e) aktualisieren](#update-contact-s), [Kontakte auflisten](#list-contacts), und [Einen Kontakt abrufen](#get-a-contact).

| Name (\* immer vorhanden) | Beschreibung                                                                              |
| ------------------------- | ----------------------------------------------------------------------------------------- |
| `id`\*                    | Kontakt-UUID                                                                              |
| `gelöscht`\*              | Ob der Kontakt gelöscht ist                                                               |
| `modified_at`\*           | Unix-Zeitstempel, wann der Kontakt zuletzt geändert wurde                                 |
| `contact_book`\*          | Adressbuch-UUID                                                                           |
| `first_name`              |                                                                                           |
| `last_name`               |                                                                                           |
| `middle_name`             |                                                                                           |
| `phonetic_first_name`     |                                                                                           |
| `phonetic_last_name`      |                                                                                           |
| `phonetic_middle_name`    |                                                                                           |
| `prefix`                  |                                                                                           |
| `Namenszusatz`            |                                                                                           |
| `Spitzname`               |                                                                                           |
| `file_as`                 |                                                                                           |
| `notes`                   |                                                                                           |
| `Markiert`                | Boolescher Wert                                                                           |
| `Geschlecht`              |                                                                                           |
| `Pronomen`                |                                                                                           |
| `job_title`               |                                                                                           |
| `Infos`                   | Array von Kontaktdaten (siehe Arten von Kontaktinformationen in der Anfragedokumentation) |
| `Mitgliedschaften`        | Array von Kontaktmitgliedschaften (siehe Anforderungsdokumentation)                       |

{% hint style="info" %}
Ein gelöschter Kontakt wurde über `modified_since` + `include_deleted=true` wird nur enthalten `id`, `deleted: true`, und `modified_at`.
{% endhint %}

### Kontakt(e) aktualisieren

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

Eine erfolgreiche Anfrage gibt die aktualisierten Kontakte mit eingebetteten zurück `Mitgliedschaften` und `Infos`.

{% code title="Anfrage-Payload" %}

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

{% endcode %}

**Attribute**

Kontakt `id` ist erforderlich. Siehe den Abschnitt Kontakte erstellen für weitere Attribute. Wenn Sie einen Kontakt aktualisieren, können Sie nur die Attribute übergeben, die Sie aktualisieren möchten. Im obigen Beispiel wird nur der Nachname aktualisiert.

{% hint style="warning" %}
Die `Infos` und `Mitgliedschaften` Arrays sind Ausnahmen: Wenn Sie sie übergeben, müssen Sie alle Elemente einschließen. Fehlende Elemente werden aus dem Kontakt gelöscht. Um Elemente zu löschen, lassen Sie sie im Array weg.
{% endhint %}

### Kontakte auflisten

`GET /v1/contacts`

Dieser Endpoint ist nützlich, um Missive-Kontakte mit einem anderen Dienst zu synchronisieren oder Kontakte anhand eines Suchbegriffs zu finden.

{% code title="Vorlage" %}

```json
{
  "Kontakte": [
    {
      "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 %}

**Parameter**

| Name (\* erforderlich) | Standard    | Beschreibung                                                                                                                                                                                                             |
| ---------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `contact_book`\*       |             | Adressbuch-ID                                                                                                                                                                                                            |
| `order`                | `last_name` | Die Standardreihenfolge erfolgt nach dem Nachnamen des Kontakts. Um die zuletzt aktualisierten Kontakte zu erhalten, übergeben Sie `last_modified`                                                                       |
| `limit`                | `50`        | Anzahl der zurückgegebenen Kontakte. Maximalwert: `200`                                                                                                                                                                  |
| `offset`               | `0`         | Versatz für die Paginierung.                                                                                                                                                                                             |
| `modified_since`       | `null`      | Um nur Kontakte zurückzugeben, die seit einem bestimmten Zeitpunkt geändert oder erstellt wurden, übergeben Sie einen Unix-Epoch-Zeitstempel wie `1556137749`.                                                           |
| `include_deleted`      | `false`     | Gelöschte Kontakte in die Ergebnisse von einbeziehen `modified_since` Anfragen, durchlassen `true`. Nur der Kontakt `id` und `gelöscht` Attribute werden zurückgegeben, da die Kontaktdaten aus Missive gelöscht wurden. |
| `Suchen`               | `null`      | Textzeichenfolge zum Filtern von Kontakten. `Suchen` Begriff(e) werden mit allen Kontaktinformationen abgeglichen: Name, E-Mail, Telefon, Organisation, benutzerdefinierte Felder, Notizen usw.                          |

### Einen Kontakt abrufen

`GET /v1/contacts/:id`

Einen bestimmten Kontakt mithilfe des contact abrufen `id`. Der Versuch, einen gelöschten Kontakt abzurufen, führt zu einer 404-Antwort.

***

## Adressbücher

In Missive werden Kontakte in Adressbüchern gespeichert. Adressbücher können privat sein oder mit verschiedenen Mitgliedern einer Organisation geteilt werden.

### Adressbücher auflisten

`GET /v1/contact_books`

Listen Sie die Adressbücher auf, auf die der authentifizierte Benutzer Zugriff hat. Denken Sie daran, dass ein Adressbuch `id` beim programmgesteuerten Erstellen eines Kontakts erforderlich ist.

{% code title="Vorlage" %}

```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": [],
      "organization": "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": [],
      "organization": "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": [],
      "Organisation": null,
      "name": "Mein persönliches Buch",
      "description": null
    }
  ]
}
```

{% endcode %}

**Parameter**

| Name (\* erforderlich) | Standard | Beschreibung                                                |
| ---------------------- | -------- | ----------------------------------------------------------- |
| `limit`                | `50`     | Anzahl der zurückgegebenen Adressbücher. Maximalwert: `200` |
| `offset`               | `0`      | Versatz für die Paginierung.                                |

**Adressbuch-Eigenschaften**

| Name (\* immer vorhanden)     | Beschreibung                                                          |
| ----------------------------- | --------------------------------------------------------------------- |
| `id`\*                        | Adressbuch-UUID                                                       |
| `name`\*                      | Adressbuchname                                                        |
| `Benutzer`\*                  | UUID des zugehörigen Benutzers                                        |
| `Organisation`                | Organisation-UUID für geteilte Bücher                                 |
| `Mit Organisation teilen`\*   | Ob das Buch mit Alle in der Organisation geteilt ist                  |
| `share_with_team`             | Team-UUID, wenn mit einem bestimmten Team geteilt                     |
| `mit_Nutzer_teilen`\*         | Array von Benutzer-UUIDs, mit denen das Buch ausdrücklich geteilt ist |
| `description`                 | Beschreibung                                                          |
| `Importieren`\*               | Ob ein Import derzeit in Bearbeitung ist                              |
| `Import-Fehlertext`           | Fehlermeldung vom letzten fehlgeschlagenen Import                     |
| `import_rows_count`           | Gesamtzahl der Zeilen im aktuellen/letzten Import                     |
| `import_processed_rows_count` | Bisher im aktuellen/letzten Import verarbeitete Zeilen                |

***

## Kontaktgruppen

Kontakte können sowohl in Organisationen als auch in Gruppen gruppiert werden. Organisationen werden typischerweise verwendet, um eine Gruppe zusammenhängender Kontakte abzubilden (Unternehmen). Gruppen werden verwendet, um nicht zusammenhängende Kontakte zu gruppieren; betrachten Sie Gruppen als Labels.

### Kontaktgruppen auflisten

`GET /v1/contact_groups`

Kontaktgruppen oder Organisationen auflisten, die mit einem Adressbuch verknüpft sind.

{% code title="Vorlage" %}

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

{% endcode %}

**Parameter**

| Name (\* erforderlich) | Standard | Beschreibung                                                     |
| ---------------------- | -------- | ---------------------------------------------------------------- |
| `contact_book`\*       |          | Adressbuch-ID                                                    |
| `kind`\*               |          | Entweder `Gruppe` oder `Organisation`.                           |
| `limit`                | `50`     | Anzahl der zurückgegebenen Kontaktgruppen. Maximaler Wert: `200` |
| `offset`               | `0`      | Versatz für die Paginierung.                                     |

**Eigenschaften der Kontaktgruppe**

| Name (\* immer vorhanden) | Beschreibung           |
| ------------------------- | ---------------------- |
| `id`\*                    | UUID der Kontaktgruppe |
| `name`\*                  | Name der Kontaktgruppe |

***

## Unterhaltungen

{% hint style="info" %}
**Status der Unterhaltung verwalten (als erledigt markieren, verschieben, zuweisen usw.)**

Verwenden [Unterhaltungen aktualisieren](#update-conversations) um den Status der Unterhaltung zu ändern, ohne einen Beitrag hinzuzufügen. Verwenden Sie [Beiträge](#posts), [Nachrichten](#messages), oder [Entwürfe](#drafts) wenn Sie zusätzlich sichtbaren Inhalt in der Unterhaltung erstellen möchten.

Posts sind nützlich für Automatisierungen und Integrationen, die eine sichtbare Spur hinterlassen sollen, die zeigt, was die Aktion ausgelöst hat.
{% endhint %}

### Unterhaltungen auflisten

`GET /v1/conversations`

Unterhaltungen auflisten, die für den Nutzer sichtbar sind, dem der API token gehört. Muss nach Postfach, geteiltem Label oder Team gefiltert werden.

{% hint style="warning" %}
Mindestens ein Postfach-Filter ist erforderlich. Wenn Sie alle weglassen, wird ein `„Sie müssen mindestens ein Postfach paginieren“` Fehler zurückgegeben. Übergeben Sie eines von: `Posteingang`, `alle`, `Zugewiesen`, `Erledigt`, `Zurückgestellt`, `Markiert`, `Gelöscht`, `Als Spam markiert`, `Entwürfe`, `Geteiltes Label`, `Team-Posteingang`, `Team-Erledigt`, oder `team_all`.
{% endhint %}

Gibt Unterhaltungen in der Reihenfolge von der neuesten zur ältesten Aktivität zurück. Um zu paginieren, übergeben Sie einen `bis` param gleich dem `last_activity_at` der ältesten Unterhaltung, die auf der vorherigen Seite zurückgegeben wurde. Die letzte Seite ist erreicht, wenn weniger Unterhaltungen als `limit` zurückgegeben werden oder wenn alle Unterhaltungen auf einer Seite denselben `last_activity_at`.

{% hint style="info" %}
Eine Seite kann mehr Unterhaltungen zurückgeben als `limit`. Unterhaltungen, bei denen der Benutzer des API token ein Gast ist, werden mit begrenzten Daten zurückgegeben und enthalten nur die `id` und `last_activity_at` Felder.
{% endhint %}

{% code title="Vorlage" %}

```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": "Conference Badge"
      },
      "color": null,
      "assignees": [],
      "Nutzer": [
        {
          "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",
        "organization": "96cafdc6-ec6a-4439-9b0c-f55a1133b1e7",
        "active_members": ["dc3c4104-eced-4206-b532-ef84b331778a"],
        "observers": []
      },
      "shared_labels": []
    }
  ]
}
```

{% endcode %}

**Parameter**

| Name                   | Beschreibung                                                                                                                                                                                                                                                                               |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `limit`                | Anzahl der zurückgegebenen Unterhaltungen. Standard: `25`. Max.: `50`.                                                                                                                                                                                                                     |
| `bis`                  | Zeitstempelwert in Unix-Zeit, der zur Paginierung verwendet wird. Verwenden Sie den `last_activity_at` der ältesten Unterhaltung von der vorherigen Seite.                                                                                                                                 |
| `Posteingang`          | Übergeben Sie `true` um Unterhaltungen im Posteingang aufzulisten.                                                                                                                                                                                                                         |
| `alle`                 | Übergeben Sie `true` um Unterhaltungen im Postfach Alle aufzulisten.                                                                                                                                                                                                                       |
| `Zugewiesen`           | Übergeben Sie `true` um Unterhaltungen aufzulisten, die Zugewiesen an den Benutzer sind.                                                                                                                                                                                                   |
| `Erledigt`             | Übergeben Sie `true` um Unterhaltungen im Postfach Erledigt aufzulisten.                                                                                                                                                                                                                   |
| `Zurückgestellt`       | Übergeben Sie `true` um Unterhaltungen im Postfach Zurückgestellt aufzulisten.                                                                                                                                                                                                             |
| `Markiert`             | Übergeben Sie `true` um Unterhaltungen im Postfach Markiert aufzulisten.                                                                                                                                                                                                                   |
| `Gelöscht`             | Übergeben Sie `true` um Unterhaltungen im Papierkorb aufzulisten.                                                                                                                                                                                                                          |
| `Als Spam markiert`    | Übergeben Sie `true` um Unterhaltungen im Spam aufzulisten. Anmerkung: Missive verwendet „Spam“ in der Benutzeroberfläche, obwohl einige E-Mail-Anbieter dafür einen anderen Begriff verwenden.                                                                                            |
| `Entwürfe`             | Übergeben Sie `true` um Unterhaltungen in Entwürfen aufzulisten.                                                                                                                                                                                                                           |
| `Geteiltes Label`      | ID des geteilten Labels. Unterhaltungen im geteilten Label auflisten.                                                                                                                                                                                                                      |
| `Team-Posteingang`     | Team-ID. Unterhaltungen im Team-Posteingang auflisten.                                                                                                                                                                                                                                     |
| `Team-Erledigt`        | Team-ID. Unterhaltungen im Postfach Erledigt des Teams auflisten.                                                                                                                                                                                                                          |
| `team_all`             | Team-ID. Unterhaltungen im Postfach „Alle“ des Teams auflisten.                                                                                                                                                                                                                            |
| `Organisation`         | Organisation-ID. Unterhaltungen nur auf diejenigen filtern, die für die Organisation geteilt sind. Es gibt keinen Nutzen für den `Organisation` Parameter, wenn Sie einen `Geteiltes Label` oder `team_` Parameter übergeben.                                                              |
| `email`                | E-Mail-Adresse-String. Unterhaltungen nach einer bestimmten Kontakt-E-Mail-Adresse filtern (z. B., `user@example.com`). Entspricht der Adresse in den `From`, `To`, `Cc`, `Bcc` und `Antwort an` Header. Schließt sich gegenseitig mit `Domain` und `contact_organization`.                |
| `Domain`               | Domain-String. Filtern Sie Unterhaltungen nach Kontakten aus einer bestimmten E-Mail-Domain (z. B., `example.com` nicht `@example.com`). Entspricht der Domain in der `From`, `To`, `Cc`, `Bcc` und `Antwort an` Header. Schließt sich gegenseitig mit `email` und `contact_organization`. |
| `contact_organization` | UUID der Kontakt-Organisation oder -Gruppe. Filtern Sie Unterhaltungen nach Kontakten, die zu einer bestimmten Kontakt-Organisation oder Kontaktgruppe gehören. Nicht kombinierbar mit `email` und `Domain`.                                                                               |

{% hint style="warning" %}
Die `email`, `Domain`, und `contact_organization` Parameter schließen sich gegenseitig aus. Sie können jeweils nur einen dieser Kontaktfilter verwenden. Wenn Sie mehrere übergeben, wird ein 400-Fehler zurückgegeben.
{% endhint %}

### Unterhaltung abrufen

`GET /v1/conversations/:id`

Rufen Sie eine bestimmte Unterhaltung mithilfe der Unterhaltung `id`.

{% hint style="info" %}
Die zurückgegebene Unterhaltung kann eine andere `id`. Dies geschieht, wenn Unterhaltungen zusammengeführt werden; wenn Sie eine alte Unterhaltung übergeben `id` wird weiterhin funktionieren, aber die neue Unterhaltung `id` wird zurückgegeben.
{% endhint %}

{% code title="Vorlage" %}

```json
{
  "conversations": [
    {
      "id": "6d3c9b1c-7067-4a28-8ea6-ea91340b67cc",
      "subject": null,
      "latest_message_subject": "Question?","}
      "Organisation": {
        "id": "96cafdc6-ec6a-4439-9b0c-f55a1133b1e7",
        "name": "Conference Badge"
      },
      "color": null,
      "assignees": [],
      "Nutzer": [
        {
          "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",
        "organization": "96cafdc6-ec6a-4439-9b0c-f55a1133b1e7",
        "active_members": ["dc3c4104-eced-4206-b532-ef84b331778a"],
        "observers": []
      },
      "shared_labels": []
    }
  ]
}
```

{% endcode %}

**Unterhaltungseigenschaften**

Die gleiche Form wird von [Unterhaltungen auflisten](#list-conversations), [Unterhaltung abrufen](#get-a-conversation), [Unterhaltungen aktualisieren](#update-conversations), und [Unterhaltungen zusammenführen](#merge-conversations).

| Name (\* immer vorhanden)     | Beschreibung                                                                           |
| ----------------------------- | -------------------------------------------------------------------------------------- |
| `id`\*                        | UUID der Unterhaltung                                                                  |
| `created_at`\*                | Unix-Zeitstempel, als die Unterhaltung erstellt wurde                                  |
| `subject`                     | Betreff der Unterhaltung                                                               |
| `latest_message_subject`      | Betreff der letzten Nachricht in der Unterhaltung                                      |
| `Organisation`                | Organisation-Objekt (`id`, `name`)                                                     |
| `color`                       | HEX-Farbe oder Farbname (`gut`, `Warnung`, `Gefahr`)                                   |
| `Autoren`\*                   | Array von Nachrichtenautoren (`name`, `address`)                                       |
| `externe_Autoren`\*           | Teilmenge von `Autoren` ohne Kollegen                                                  |
| `Nutzer`\*                    | Array von Nutzern mit Zugriff (siehe unten User access properties)                     |
| `zugewiesene Personen`\*      | Teilmenge von `Nutzer` die der Unterhaltung zugewiesen sind                            |
| `assignee_names`\*            | Durch Kommas getrennte Anzeigenamen der zugewiesenen Personen                          |
| `assignee_emails`\*           | Durch Kommas getrennte E-Mail-Adressen der zugewiesenen Personen                       |
| `geteilte Labels`\*           | Array von geteilten Label-Objekten in der Unterhaltung                                 |
| `shared_label_names`\*        | Durch Kommas getrennte Namen der geteilten Labels                                      |
| `team`                        | Kompaktes Team-Objekt (siehe unten die Eigenschaften des kompakten Teams)              |
| `messages_count`\*            | Anzahl der Nachrichten in der Unterhaltung                                             |
| `drafts_count`\*              | Anzahl der Entwürfe in der Unterhaltung                                                |
| `send_later_messages_count`\* | Anzahl geplanter (später gesendeter) Nachrichten                                       |
| `attachments_count`\*         | Anzahl der Anhänge in allen Nachrichten                                                |
| `Aufgaben_count`\*            | Anzahl der Aufgaben in der Unterhaltung                                                |
| `completed_tasks_count`\*     | Anzahl erledigter Aufgaben                                                             |
| `last_activity_at`\*          | Unix-Zeitstempel der jüngsten Aktivität der Unterhaltung                               |
| `closed_at`                   | Unix-Zeitstempel, zu dem die Aufgabe bzw. die Unterhaltung als erledigt markiert wurde |
| `web_url`\*                   | URL zum Öffnen der Unterhaltung in der Web-App                                         |
| `app_url`\*                   | URL zum Öffnen der Unterhaltung in der Desktop-App                                     |

{% hint style="info" %}
Wenn der API token-Benutzer ein Gast in der Unterhaltung ist, nur `id` und `last_activity_at` werden zurückgegeben.
{% endhint %}

**Kompakte Team-Eigenschaften**

Die `team` Das in den Antworten zu Unterhaltungen eingebettete Objekt ist ein kompaktes Teamobjekt. Für die vollständige Team-Struktur verwenden Sie [Teams auflisten](#list-teams), [Team(s) erstellen](#create-team-s), oder [Team(s) aktualisieren](#update-team-s).

| Name (\* immer vorhanden) | Beschreibung                                       |
| ------------------------- | -------------------------------------------------- |
| `id`\*                    | Team-UUID                                          |
| `name`\*                  | Teamname                                           |
| `Organisation`\*          | Organisation-UUID                                  |
| `active_members`\*        | Array von Benutzer-UUIDs für aktive Teammitglieder |
| `Beobachter`\*            | Array von Benutzer-UUIDs für Beobachter des Teams  |

**Zugriffseigenschaften des Benutzers**

Elemente innerhalb `Nutzer` und `zugewiesene Personen` in einer Unterhaltung.

| Name (\* immer vorhanden) | Beschreibung                                                                 |
| ------------------------- | ---------------------------------------------------------------------------- |
| `id`\*                    | Benutzer-UUID                                                                |
| `name`\*                  | Anzeigename des Benutzers                                                    |
| `email`\*                 | E-Mail des Benutzers                                                         |
| `Zugewiesen`\*            | Ob dem Benutzer die Unterhaltung zugewiesen ist                              |
| `nicht zugewiesen`\*      | Ob sich die Unterhaltung im Postfach „Nicht zugewiesen“ des Nutzers befindet |
| `Erledigt`\*              | Ob sich die Unterhaltung im Postfach „Erledigt“ des Nutzers befindet         |
| `archiviert`\*            | Ob die Unterhaltung für den Nutzer archiviert ist (nicht im Posteingang)     |
| `Markiert`\*              | Ob die Unterhaltung für den Nutzer mit Stern markiert ist                    |
| `Zurückgestellt`\*        | Ob die Unterhaltung für den Nutzer zurückgestellt ist                        |
| `Gelöscht`\*              | Ob sich die Unterhaltung im Papierkorb des Nutzers befindet                  |
| `Als Spam markiert`\*     | Ob sich die Unterhaltung im Spam des Nutzers befindet                        |

### Unterhaltungen aktualisieren

`PATCH /v1/conversations/:id`

Aktualisieren Sie eine oder mehrere Unterhaltungen, ohne einen Beitrag zu erstellen. Verwenden Sie diesen Endpoint, um Unterhaltungen stillschweigend als erledigt zu markieren, wieder zu öffnen, zu verschieben, zuzuweisen, Labels hinzuzufügen, neu einzufärben oder umzubenennen. Systemereignisse können in Missive weiterhin erscheinen. Wenn die Aktualisierung Geteilte Labels ändert, werden Regeln für Label-Änderungen weiterhin ausgeführt.

Um mehrere Unterhaltungen in einer Anfrage zu aktualisieren, übergeben Sie durch Kommas getrennte IDs:

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

Der Request-Body muss ein `conversations` array mit genau einem Objekt für jede ID in der URL enthalten. Jedes Objekt muss die übereinstimmende `id`.

{% hint style="info" %}
Wenn eine Unterhaltung zusammengeführt wurde, können Sie die alte Unterhaltung `id`. Die Antwort gibt die Aktuelle Unterhaltung zurück `id`. Geben Sie bei Sammelanfragen nicht zwei IDs an, die auf dieselbe Zusammengeführte Unterhaltung aufgelöst werden.
{% endhint %}

{% code title="Anfrage" %}

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

{% endcode %}

{% code title="Vorlage" %}

```json
{
  "conversations": [
    {
      "id": "6d3c9b1c-7067-4a28-8ea6-ea91340b67cc",
      "subject": "Rückerstattung genehmigt"
    }
  ]
}
```

{% endcode %}

Die Antwort verwendet dieselbe Objektstruktur der Unterhaltung, die in [Unterhaltungseigenschaften](#conversation-properties).

**Attribute**

| Name (\* erforderlich)            | Beschreibung                                                                               | Beispiel                                   |
| --------------------------------- | ------------------------------------------------------------------------------------------ | ------------------------------------------ |
| `id`\*                            | Unterhaltungs-ID-String. Muss mit einer ID übereinstimmen, die in der URL übergeben wurde. | `"6d3c9b1c-7067-4a28-8ea6-ea91340b67cc"`   |
| `subject`                         | Betreff für Neue Unterhaltung                                                              | `„Rückerstattung genehmigt“`               |
| `color`                           | HEX-Farbcode oder `„gut“` `„Warnung“` `„Gefahr“` string                                    | `"#000"`, `„Gefahr“`                       |
| `Unterhaltungsfarbe`              | Wie `color`                                                                                | `"#000"`, `„Gefahr“`                       |
| `Organisation`                    | Organisations-ID-String                                                                    | `"90beb742-27a3-44cf-95bc-7e5097167c9d"`   |
| `team`                            | Team-ID-Zeichenkette                                                                       | `"646bb7f1-2066-40be-b8f6-bacb8b3b7419"`   |
| `force_team`                      | boolean                                                                                    | `false`                                    |
| `Nutzer hinzufügen`               | Array von Benutzer-ID-Strings                                                              | `["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]` |
| `Zugewiesene Personen hinzufügen` | Array von Benutzer-ID-Strings                                                              | `["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]` |
| `remove_assignees`                | Array von Benutzer-ID-Strings                                                              | `["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]` |
| `geteilte Labels hinzufügen`      | Array von Zeichenketten mit geteilten Label-IDs                                            | `["9825718b-3407-40b8-800d-a27361c86102"]` |
| `remove_shared_labels`            | Array von Zeichenketten mit geteilten Label-IDs                                            | `["e4aae78f-e932-40a2-9ece-ed764aa85790"]` |
| `Zum Posteingang hinzufügen`      | boolean                                                                                    | `true`                                     |
| `Zum Team-Posteingang hinzufügen` | boolean                                                                                    | `true`                                     |
| `Erledigen`                       | boolean                                                                                    | `true`                                     |
| `Wieder öffnen`                   | boolean                                                                                    | `true`                                     |

`Organisation`

`Organisation` ist erforderlich bei Verwendung von `Nutzer hinzufügen`, `Zugewiesene Personen hinzufügen`, `remove_assignees`, oder `geteilte Labels hinzufügen`.

`team`

`team` ändert das Team der Unterhaltung, wenn die Unterhaltung nicht bereits mit einem anderen Team verknüpft ist.

`force_team`

`force_team` erzwingt ein neues Team, selbst wenn die Unterhaltung bereits in einem anderen Team ist.

`add_assignees, remove_assignees`

`Zugewiesene Personen hinzufügen` weist Nutzer der Unterhaltung zu. `remove_assignees` entfernt Nutzer aus den zugewiesenen Personen der Unterhaltung. Beide erfordern `Organisation`, und die Nutzer-IDs müssen Mitgliedern dieser Organisation gehören.

`add_shared_labels, remove_shared_labels`

`geteilte Labels hinzufügen` und `remove_shared_labels` verwaltet Geteilte Labels in der Unterhaltung. Beim Hinzufügen von Labels müssen sie zu `Organisation` gehören und für den Nutzer des API token sichtbar sein.

`Zum Team-Posteingang hinzufügen`

`Zum Team-Posteingang hinzufügen` verschiebt die Unterhaltung in einen Team-Posteingang. Wenn Sie `Zum Team-Posteingang hinzufügen`, angeben, `team` ist das Feld erforderlich.

`Zum Posteingang hinzufügen`

`Zum Posteingang hinzufügen` verschiebt die Unterhaltung für alle mit Zugriff auf die Unterhaltung in den Posteingang.

`Erledigen`

`Erledigen` markiert die Unterhaltung für alle mit Zugriff auf die Unterhaltung als erledigt.

`Wieder öffnen`

`Wieder öffnen` öffnet die Unterhaltung für alle mit Zugriff auf die Unterhaltung wieder.

### Nachrichten der Unterhaltung auflisten

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

Listet die Nachrichten in der übergebenen Unterhaltung auf `id`. Entwürfe werden ausgeschlossen.

Gibt Nachrichten zurück, sortiert von neu nach alt. Für die Seitennavigation übergeben Sie ein `bis` param gleich dem `delivered_at` der ältesten Nachricht, die auf der vorherigen Seite zurückgegeben wurde. Die letzte Seite ist erreicht, wenn weniger Nachrichten als `limit` zurückgegeben werden oder wenn alle Nachrichten auf einer Seite denselben `delivered_at`.

{% hint style="info" %}
Eine Seite kann mehr Nachrichten zurückgeben als `limit`.
{% endhint %}

{% code title="Vorlage" %}

```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 %}

**Parameter**

| Name    | Beschreibung                                                                                                                                    |
| ------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `limit` | Anzahl der zurückgegebenen Nachrichten. Standard: `10`. Max.: `10`                                                                              |
| `bis`   | Zeitstempelwert in Unix-Zeit, der zur Paginierung verwendet wird. Verwenden Sie den `delivered_at` der ältesten Nachricht der vorherigen Seite. |

**Nachrichteneigenschaften**

Die gleiche Form wird von [Nachrichten der Unterhaltung auflisten](#list-conversation-messages), [Entwürfe der Unterhaltung auflisten](#list-conversation-drafts), [Nachrichten auflisten](#list-messages), und [Nachricht abrufen](#get-a-message). Das `body` Feld ist nur enthalten in [Nachricht abrufen](#get-a-message). Einige Schlüssel sind kanalspezifisch (siehe Hinweise unten).

| Name (\* immer vorhanden) | Beschreibung                                                                                                                                                        |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`\*                    | Eintrags-UUID                                                                                                                                                       |
| `type`\*                  | Nachrichtentyp: `email`, `custom_email`, `custom_text`, `custom_html`, `twilio_message`, `messenger_message`, `instagram_message`, usw.                             |
| `preview`\*               | Kurze Textvorschau des Nachrichtentexts                                                                                                                             |
| `delivered_at`\*          | Unix-Zeitstempel, wenn die Nachricht zugestellt wurde                                                                                                               |
| `updated_at`\*            | Unix-Zeitstempel, wenn die Nachricht zuletzt aktualisiert wurde                                                                                                     |
| `created_at`\*            | Unix-Zeitstempel, wenn der Nachrichtendatensatz in Missive erstellt wurde                                                                                           |
| `from_field`\*            | Absender. E-Mail-Kanal: Objekt mit `name`, `address`. Andere Kanäle: Objekt mit `id`, `name`, `username`. Für WhatsApp siehe den Hinweis zu Breaking Changes unten. |
| `to_fields`\*             | Array von Empfängern in derselben Form wie `from_field`                                                                                                             |
| `attachments`\*           | Array von Anhang-Objekten (siehe Anhang-Eigenschaften)                                                                                                              |
| `references`\*            | Array von `Message-ID` Zeichenketten, auf die diese Nachricht verweist                                                                                              |
| `subject`                 | E-Mail-Betreff. Nur E-Mail-Kanal                                                                                                                                    |
| `cc_fields`               | Array von CC-Empfängern. Nur E-Mail-Kanal                                                                                                                           |
| `bcc_fields`              | Array von BCC-Empfängern. Nur E-Mail-Kanal                                                                                                                          |
| `reply_to_fields`         | Array von Reply-To-Empfängern. Nur E-Mail-Kanal                                                                                                                     |
| `email_message_id`        | E-Mail `Message-ID` Header (eingeschlossen in `<>`). Nur E-Mail-Kanal                                                                                               |
| `in_reply_to`             | Array von `Message-ID` Zeichenketten, auf die diese Nachricht antwortet. Nur E-Mail-Kanal                                                                           |
| `external_id`             | Nachrichten-ID des Anbieters. Nur Nicht-E-Mail-Kanäle (SMS, Messenger usw.)                                                                                         |
| `author`                  | Benutzer, der die Nachricht verfasst hat (bei ausgehenden Nachrichten)                                                                                              |
| `body`                    | HTML-Text der Nachricht. Wird nur von [Nachricht abrufen](#get-a-message)                                                                                           |
| `account_author`          | Älterer Alias für `from_field`. Wird nur für SMS-, Messenger- und Twitter-Nachrichten zurückgegeben                                                                 |
| `account_recipients`      | Älterer Alias für `to_fields`. Wird nur für SMS-, Messenger- und Twitter-Nachrichten zurückgegeben                                                                  |

{% hint style="warning" %}
**Breaking Change für WhatsApp**

Bei WhatsApp-Nachrichten ist das `id` in `from_field` und `to_fields` identifiziert Autoren und Empfänger anhand ihrer **Business-Scoped User ID (BSUID)**, die Kennung, die Meta verwendet, um einen WhatsApp-Nutzer innerhalb Ihres Unternehmens statt der Telefonnummer des Kontakts zu referenzieren. Zum Beispiel der `id` ändert sich von `whatsapp:+14155551234` zu `whatsapp:US.13491208655302741918`.

Wenn sich Ihre Integration auf `from_field.id` oder `to_fields[].id` als Telefonnummer für WhatsApp stützte, aktualisieren Sie sie so, dass sie die BSUID verwendet. Das `username` Feld enthält den WhatsApp-Benutzernamen des Kontakts, wenn er einen festgelegt hat, andernfalls fällt es auf seine Telefonnummer zurück.
{% endhint %}

{% hint style="info" %}
Wenn der Benutzer des API token nicht mit der Nachricht verbunden ist (weder Autor, Empfänger noch Follower), können sensible Felder wie `body`, `preview`, und Empfängerlisten möglicherweise geschwärzt werden.
{% endhint %}

**Eigenschaften von Anhängen**

Zurückgegeben im `attachments` Array von Nachrichten, Entwürfen, Kommentaren, Beiträgen und Vorlagen.

| Name (\* immer vorhanden) | Beschreibung                                               |
| ------------------------- | ---------------------------------------------------------- |
| `id`\*                    | UUID des Anhangs                                           |
| `filename`\*              | Ursprünglicher Dateiname                                   |
| `extension`\*             | Dateierweiterung (z. B. `png`, `pdf`)                      |
| `media_type`\*            | MIME-Typ der obersten Ebene (z. B. `image`, `application`) |
| `sub_type`\*              | MIME-Untertyp (z. B. `png`, `pdf`)                         |
| `size`\*                  | Dateigröße in Bytes                                        |
| `url`\*                   | Signierte URL zum Herunterladen der Datei                  |
| `width`                   | Bildbreite in Pixeln                                       |
| `height`                  | Bildhöhe in Pixeln                                         |

### Kommentare der Unterhaltung auflisten

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

Kommentare in der als übergebenen Unterhaltung auflisten `id`.

Gibt Kommentare sortiert von neuestem zu ältestem zurück. Um zu paginieren, übergeben Sie ein `bis` param gleich dem `created_at` des ältesten Kommentars, der auf der vorherigen Seite zurückgegeben wurde. Die letzte Seite ist erreicht, wenn weniger Kommentare als `limit` zurückgegeben werden oder wenn alle Kommentare auf einer Seite denselben `created_at`.

{% hint style="info" %}
Eine Seite kann mehr Kommentare zurückgeben als `limit`.
{% endhint %}

{% code title="Vorlage" %}

```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",
          "organization": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92"
        }
      }
    }
  ]
}
```

{% endcode %}

**Parameter**

| Name    | Beschreibung                                                                                                                                       |
| ------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `limit` | Anzahl der zurückgegebenen Kommentare. Standard: `10`. Max.: `10`                                                                                  |
| `bis`   | Zeitstempelwert in Unix-Zeit, der zur Paginierung verwendet wird. Verwenden Sie den `created_at` des ältesten Kommentars von der vorherigen Seite. |

**Kommentar-Eigenschaften**

| Name (\* immer vorhanden) | Beschreibung                                                                                                |
| ------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `id`\*                    | Eindeutige ID des Kommentareintrags                                                                         |
| `body`\*                  | Textinhalt des Kommentars                                                                                   |
| `created_at`\*            | Zeitstempel, zu dem der Kommentar erstellt wurde                                                            |
| `Erwähnungen`\*           | Array der Benutzer-Erwähnungen im Kommentar, mit Indizes, um sie im Textkörper zu lokalisieren              |
| `author`\*                | Benutzer, der den Kommentar erstellt hat                                                                    |
| `Anhang`                  | Datei, die an den Kommentar angehängt ist                                                                   |
| `Aufgabe`                 | Wenn der Kommentar einer Aufgabe zugeordnet ist, das vollständige Aufgabenobjekt (siehe [Aufgaben](#tasks)) |

### Entwürfe der Unterhaltung auflisten

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

Entwurfsnachrichten in der als übergebenen Unterhaltung auflisten `id`.

Gibt Entwürfe in Reihenfolge von neuestem zu ältestem zurück. Zum Paginieren übergeben Sie einen `bis` param gleich dem `delivered_at` des ältesten Entwurfs, der auf der vorherigen Seite zurückgegeben wurde. Die letzte Seite ist erreicht, wenn weniger Entwürfe als `limit` zurückgegeben werden oder wenn alle Entwürfe auf einer Seite dieselbe `delivered_at`.

{% hint style="info" %}
Eine Seite kann mehr Entwürfe zurückgeben als `limit`.
{% endhint %}

{% code title="Vorlage" %}

```json
{
  "drafts": [
    {
      "id": "3fa4bcf5-e57e-47a4-9422-de2cce5f802e",
      "subject": "Draft Message",
      "draft": true,
      "preview": "A draft message",
      "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 %}

**Parameter**

| Name    | Beschreibung                                                                                                                                       |
| ------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `limit` | Anzahl der zurückgegebenen Entwürfe. Standard: `10`. Max.: `10`                                                                                    |
| `bis`   | Zeitstempelwert in Unix-Zeit, der zur Paginierung verwendet wird. Verwenden Sie den `delivered_at` des ältesten Entwurfs von der vorherigen Seite. |

### Unterhaltungsbeiträge auflisten

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

Beiträge in der als übergebenen Unterhaltung auflisten `id`.

Gibt Beiträge in Reihenfolge von neuestem zu ältestem zurück. Zum Paginieren übergeben Sie einen `bis` param gleich dem `created_at` des ältesten Beitrags, der auf der vorherigen Seite zurückgegeben wurde. Die letzte Seite ist erreicht, wenn weniger Beiträge als `limit` zurückgegeben werden oder wenn alle Beiträge auf einer Seite dieselbe `created_at`.

{% hint style="info" %}
Eine Seite kann mehr Beiträge zurückgeben als `limit`.
{% endhint %}

{% code title="Vorlage" %}

```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": "A title",
        "body": "A body"
      },
      "attachments": [
        {
          "author_name": "Philippe Lehoux",
          "author_link": "mailto:philippe@missiveapp.com",
          "author_icon": "avatar:philippe@missiveapp.com",
          "color": "#2266ED",
          "text": "New customer signed up!",
          "timestamp": 1511540318
        }
      ]
    }
  ]
}
```

{% endcode %}

**Parameter**

| Name    | Beschreibung                                                                                                                                     |
| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `limit` | Anzahl der zurückgegebenen Beiträge. Standard: `10`. Max.: `10`                                                                                  |
| `bis`   | Zeitstempelwert in Unix-Zeit, der zur Paginierung verwendet wird. Verwenden Sie den `created_at` des ältesten Beitrags von der vorherigen Seite. |

**Beitrags-Eigenschaften**

Zurückgegeben von [Unterhaltungsbeiträge auflisten](#list-conversation-posts). Siehe [Einen Beitrag erstellen](#create-a-post) für die Bedeutung jedes Feldes.

| Name (\* immer vorhanden) | Beschreibung                                                               |
| ------------------------- | -------------------------------------------------------------------------- |
| `id`\*                    | UUID des Beitrags-Eintrags                                                 |
| `created_at`\*            | Unix-Zeitstempel, als der Beitrag erstellt wurde                           |
| `username`                | Angezeigter Name des Beitragsautors                                        |
| `username_icon`           | Bild-URL, die als Avatar des Beitragsautors angezeigt wird                 |
| `conversation_icon`       | Bild-URL, die als Unterhaltungssymbol verwendet wird                       |
| `notification`            | Objekt mit `title` und `body` zum Rendern einer Benachrichtigung verwendet |
| `text`                    | Klartextkörper des Beitrags                                                |
| `markdown`                | Markdown-formatierter Inhalt des Beitrags                                  |
| `attachments`             | Array von Anhang-Objekten (formatierte Blöcke oder Dateien)                |
| `from_field`              | Objekt mit `name`, `address`, oder `phone_number` zur Suche des Autors     |
| `references`              | Array von Nachrichten-Referenzstrings                                      |

### Unterhaltungen zusammenführen

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

Führen Sie die Unterhaltung zusammen, die als `:id` in die Unterhaltung, die als `Ziel`. Nach dem Zusammenführen wird die Quell-Unterhaltung (`:id`) als ersetzt markiert, und alle ihre Nachrichten, Kommentare und anderen Einträge werden Teil der Ziel-Unterhaltung.

{% hint style="info" %}
Wenn Unterhaltungen während des Zusammenführens vertauscht werden (z. B. wenn eine Unterhaltung der Organisation in eine private Unterhaltung zusammengeführt wird oder wenn die Quell-Unterhaltung deutlich mehr Einträge hat), kann die zurückgegebene Unterhaltung `id` sich von der als `Ziel`.
{% endhint %}

{% code title="Anfrage" %}

```json
{
  "target": "3fa4bcf5-e57e-47a4-9422-de2cce5f802e",
  "subject": "Optionaler neuer Betreff"
}
```

{% endcode %}

{% code title="Vorlage" %}

```json
{
  "conversations": [
    {
      "id": "6d3c9b1c-7067-4a28-8ea6-ea91340b67cc",
      "created_at": 1654544954,
      "subject": "Optionaler neuer Betreff",
      "latest_message_subject": "Question?","}
      "Organisation": {
        "id": "96cafdc6-ec6a-4439-9b0c-f55a1133b1e7",
        "name": "Conference Badge"
      },
      "color": null,
      "assignees": [],
      "Nutzer": [
        {
          "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 %}

**Parameter**

| Name \* erforderlich | Beschreibung                                         |
| -------------------- | ---------------------------------------------------- |
| `Ziel`\*             | UUID der Ziel-Unterhaltung (die bestehen bleibt).    |
| `subject`            | Neuer Betreff für die zusammengeführte Unterhaltung. |

Die UUID der Quell-Unterhaltung wird in der URL als `:id`.

***

## Entwürfe

Das drafts endpoint ermöglicht es Ihnen, E-Mail-, SMS-, WhatsApp- und Missive Live Chat-Entwürfe zu erstellen, die entweder sofort gesendet oder bearbeitet und aus der Missive-App gesendet werden können. Sie können Entwürfe in einer neuen Unterhaltung erstellen oder sie als Antwort an eine bestehende anhängen.

{% hint style="info" %}
**Dies ist das endpoint zum Senden von E-Mails.** Um sofort zu senden, fügen Sie `send: true` in Ihrer Anfrage hinzu. Um auf eine bestehende Unterhaltung zu antworten, verwenden Sie die `conversation` oder `references` Parameter.
{% endhint %}

{% hint style="info" %}
**Beispiel:** Erstellen Sie bei jedem Ausfüllen eines Formulars auf Ihrer Website einen neuen Entwurf in einem geteilten Label namens „Follow up“ mit einem bestimmten Inhalt.
{% endhint %}

### Entwurf erstellen

`POST /v1/drafts`

{% code title="Anfrage-Payload" %}

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

{% endcode %}

**Attribute**

| Name (\* erforderlich)                                                       | Beschreibung                                                                                                                                                                                                                                                                                                                                                              | Beispiel                                                                |
| ---------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| `subject`                                                                    | string                                                                                                                                                                                                                                                                                                                                                                    | `"Hello"`                                                               |
| `body`                                                                       | HTML- oder Text-Zeichenfolge                                                                                                                                                                                                                                                                                                                                              | `"<b>World!</b>"`                                                       |
| `quote_previous_message`                                                     | boolean                                                                                                                                                                                                                                                                                                                                                                   | `false`                                                                 |
| `add_default_signature`                                                      | boolean                                                                                                                                                                                                                                                                                                                                                                   | `false`                                                                 |
| `from_field` E-Mail                                                          | Objekt mit `"address"` und `"name"` Schlüssel.                                                                                                                                                                                                                                                                                                                            | `{"address": "philippe@missiveapp.com", "name": "Philippe Lehoux"}`     |
| `from_field` SMS & WhatsApp                                                  | Objekt mit `„phone_number“` Schlüssel, er muss mit einer Kontonummer übereinstimmen, auf die Sie Zugriff haben, formatiert als `"+"` gefolgt nur von Ziffern. Ein optionaler `"type"` Schlüssel mit Werten von `"signalwire"`, `"twilio"`, `"twilio_whatsapp"` oder `"WhatsApp"` muss angegeben werden, wenn die Telefonnummer Konten unterschiedlicher Typen entspricht. | `{"phone_number": "+18005550199", "type": "whatsapp"}`                  |
| `from_field` Benutzerdefinierter Kanal                                       | Objekt mit `"id"`, `"username"` und `"name"` Schlüssel.                                                                                                                                                                                                                                                                                                                   | `{"id": "12345", "username": "@missiveapp", "name": "Missive"}`         |
| `to_fields` E-Mail                                                           | Array von Objekten. Objekt mit `"address"` und `"name"` Schlüssel.                                                                                                                                                                                                                                                                                                        | `[{"address": "philippe@missiveapp.com", "name": "Philippe Lehoux"}]`   |
| `to_fields` SMS & WhatsApp                                                   | Array von Objekten. Objekt mit `„phone_number“` Schlüssel, nur ein Element ist zulässig und es muss formatiert sein als `"+"` gefolgt nur von Ziffern.                                                                                                                                                                                                                    | `[{"phone_number": "+18005550199"}]`                                    |
| `to_fields` Messenger & Instagram                                            | Array von Objekten. Objekt mit dem `"id"` Schlüssel.                                                                                                                                                                                                                                                                                                                      | `[{"id": "1736313053102918"}]`                                          |
| `to_fields` Benutzerdefinierter Kanal                                        | Array von Objekten. Objekt mit `"id"`, `"username"` und `"name"` Schlüssel.                                                                                                                                                                                                                                                                                               | `[{"id": "12345", "username": "@missiveapp", "name": "Missive"}]`       |
| `to_fields` Missive Live Chat                                                | Array mit einem Objekt. Objekt mit `"id"`, `"username"` und `"name"` Schlüssel.                                                                                                                                                                                                                                                                                           | `[{ id: '123', username: 'phil@acme.com', name: 'Phil [Unverified]' }]` |
| `cc_fields`                                                                  | Array von Objekten mit `"address"` und `"name"` Schlüssel.                                                                                                                                                                                                                                                                                                                | `[{"address": "philippe@missiveapp.com", "name": "Philippe Lehoux"}]`   |
| `bcc_fields`                                                                 | Array von Objekten mit `"address"` und `"name"` Schlüssel.                                                                                                                                                                                                                                                                                                                | `[{"address": "philippe@missiveapp.com", "name": "Philippe Lehoux"}]`   |
| `Konto` Benutzerdefinierter Kanal & Missive Live Chat, Messenger & Instagram | Konto-ID. Sie finden diese ID im benutzerdefinierten Kanal, in den Missive Live Chat-Einstellungen oder unter Einstellungen > API > Ressourcen-IDs.                                                                                                                                                                                                                       | `"fbf74c47-d0a0-4d77-bf3c-2118025d8102"`                                |
| `attachments`                                                                | Array mit Dateien, siehe unten für Details                                                                                                                                                                                                                                                                                                                                | `[{"base64_data": "iVBORw0KGgoAAAANS…", "filename": "logo.png"}]`       |
| `references`                                                                 | Array von Strings zum Anhängen an eine bestehende Unterhaltung.                                                                                                                                                                                                                                                                                                           | `["<some-reference-123>"]`                                              |
| `from_field`                                                                 | Objekt mit den `„phone_number“`, `"address"` oder `"name"` Schlüsseln, die verwendet werden, um Kontakte in der Missive-Seitenleiste abzugleichen und die Autorenzeile in der Vorschau der Unterhaltung zu füllen                                                                                                                                                         | `{"phone_number": "+4187249887", "name": "Paul"}`                       |
| `conversation`                                                               | Unterhaltungs-ID-String zum Anhängen an eine bestehende Unterhaltung                                                                                                                                                                                                                                                                                                      | `"5bb24363-69e5-48ed-80a9-feee988bc953"`                                |
| `team`                                                                       | Team-ID-Zeichenkette                                                                                                                                                                                                                                                                                                                                                      | `"646bb7f1-2066-40be-b8f6-bacb8b3b7419"`                                |
| `force_team`                                                                 | boolean                                                                                                                                                                                                                                                                                                                                                                   | `false`                                                                 |
| `Organisation`                                                               | Organisations-ID-String                                                                                                                                                                                                                                                                                                                                                   | `"90beb742-27a3-44cf-95bc-7e5097167c9d"`                                |
| `Nutzer hinzufügen`                                                          | Array von Benutzer-ID-Strings                                                                                                                                                                                                                                                                                                                                             | `["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]`                              |
| `Zugewiesene Personen hinzufügen`                                            | Array von Benutzer-ID-Strings                                                                                                                                                                                                                                                                                                                                             | `["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]`                              |
| `remove_assignees`                                                           | Array von Benutzer-ID-Strings                                                                                                                                                                                                                                                                                                                                             | `["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]`                              |
| `conversation_subject`                                                       | string                                                                                                                                                                                                                                                                                                                                                                    | `"Neuer Nutzer!"`                                                       |
| `Unterhaltungsfarbe`                                                         | HEX-Farbcode oder `„gut“` `„Warnung“` `„Gefahr“` string                                                                                                                                                                                                                                                                                                                   | `"#000"`, `„Gefahr“`                                                    |
| `geteilte Labels hinzufügen`                                                 | Array von Zeichenketten mit geteilten Label-IDs                                                                                                                                                                                                                                                                                                                           | `["9825718b-3407-40b8-800d-a27361c86102"]`                              |
| `remove_shared_labels`                                                       | Array von Zeichenketten mit geteilten Label-IDs                                                                                                                                                                                                                                                                                                                           | `["e4aae78f-e932-40a2-9ece-ed764aa85790"]`                              |
| `Zum Posteingang hinzufügen`                                                 | boolean                                                                                                                                                                                                                                                                                                                                                                   | `false`                                                                 |
| `Zum Team-Posteingang hinzufügen`                                            | boolean                                                                                                                                                                                                                                                                                                                                                                   | `false`                                                                 |
| `Erledigen`                                                                  | boolean                                                                                                                                                                                                                                                                                                                                                                   | `false`                                                                 |
| `send`                                                                       | boolean                                                                                                                                                                                                                                                                                                                                                                   | `false`                                                                 |
| `send_at`                                                                    | Zeitstempelwert in Unix-Zeit                                                                                                                                                                                                                                                                                                                                              | `1684540565`                                                            |
| `auto_followup`                                                              | boolesch, `send_at` ist erforderlich, wenn übergeben `true`                                                                                                                                                                                                                                                                                                               | `false`                                                                 |
| `external_response_id` WhatsApp                                              | Die Twilio- oder Meta-ID der Vorlage, die Sie verwenden.                                                                                                                                                                                                                                                                                                                  | `474808552386201`                                                       |
| `external_response_variables` WhatsApp                                       | Ein Objekt, das die Variablenwerte für die Vorlage enthält, die Sie verwenden.                                                                                                                                                                                                                                                                                            | `{ "1": "Philippe", "2": "This awesome project" }`                      |

`body`

Der HTML-/Text-Inhalt Ihrer Nachricht. Gewöhnliche HTML-Absatz-Tags in Missive zeigen nicht den gewünschten Abstand an.

Zum Beispiel würden Sie dies ändern, um den erwarteten Abstand zwischen Absätzen zu erhalten:

```
<p>Paragraph 1</p>
<p>Paragraph 2</p>
```

zu:

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

{% hint style="info" %}
**Der Dunkelmodus wird für Sie automatisch berücksichtigt.** Wenn ein Leser mit dem dunklen Design eine E-Mail öffnet, die für einen hellen Hintergrund gestaltet ist, generiert Missive eine dunkle Version Ihrer `body`: helle Hintergründe werden abgedunkelt, fest codierter dunkler Text (zum Beispiel Schwarz) wird aufgehellt, damit er lesbar bleibt, und gesättigte Markenfarben bleiben unverändert. Leser können eine einzelne Nachricht wieder auf ihre ursprünglichen Farben umschalten. Sie können Textfarben weiterhin unformatiert lassen, damit sie das Design des Lesers übernehmen, aber fest codierte Farben beeinträchtigen die Lesbarkeit im Dunkelmodus nicht mehr.
{% endhint %}

`quote_previous_message`

Wenn `true`, enthält der Entwurf eine zitierte Version der letzten Nachricht in der Unterhaltung.

{% hint style="danger" %}
Seien Sie bei der Verwendung dieses Parameters äußerst vorsichtig. Wenn Sie mit diesem Parameter einen Entwurf in einer bestehenden Unterhaltung erstellen `conversation` oder `references`, enthält der zitierte Inhalt den Textkörper der vorherigen Nachricht. Dadurch könnten potenziell sensible Informationen offengelegt werden, wenn Sie sich nicht über den Inhalt der vorherigen Nachricht sicher sind. Verwenden Sie diesen Parameter nur, wenn Sie die volle Kontrolle über den Kontext der Unterhaltung haben und diesen einsehen können.
{% endhint %}

`add_default_signature`

Wenn `true`, wird die für den sendenden E-Mail-Alias festgelegte Signatur zu dem `body`, genau wie beim Verfassen eines Entwurfs in Missive. Funktioniert nur für E-Mails und nur, wenn der `from_field` Alias eine Signatur hat.

`send`

Setzen Sie es auf `true` um den Entwurf sofort nach dem Erstellen zu senden.

{% hint style="info" %}
**Ausgehende Regeln werden automatisch ausgelöst.** Wenn Sie über die API eine Nachricht mit `send: true`, werden alle passenden Regeln für ausgehende Nachrichten ausgeführt. Dazu gehören Regeln mit [steps](https://missiveapp.com/docs/advanced-features/rules/steps) die Follow-ups senden und so automatisierte E-Mail-Sequenzen ermöglichen. Siehe [Automatisierte E-Mail-Sequenzen](#use-case-automated-email-sequences) unten.
{% endhint %}

`send_at`

Planen Sie, dass der Entwurf zu einem späteren Zeitpunkt gesendet wird. Kann nicht kombiniert werden mit `send: true`.

`auto_followup`

Wenn `auto_followup` ist `true`, wird der geplante Entwurf zu einem späteren Zeitpunkt mit `send_at` verworfen, wenn es eine Antwort in der Unterhaltung gibt.

`from_field`

`from_field` muss entweder ein `address` haben, das zu einem Ihrer E-Mail-Aliasse in Missive passt, oder ein `phone_number` haben, das zu einem Ihrer Twilio- oder SignalWire-Konten passt. Für benutzerdefinierte Kanäle können Sie jeden `id`, `username` und `name` ohne Einschränkung übergeben.

`attachments`

Die `attachments` Mit diesem Array können Sie dem Entwurf bis zu 25 Dateien anhängen. Die gesamte JSON-Payload Ihrer Anfrage darf 10 MB nicht überschreiten.

| Name (\* erforderlich) | Beschreibung                         | Beispiel               |
| ---------------------- | ------------------------------------ | ---------------------- |
| `base64_data`\*        | Der base64-kodierte Inhalt der Datei | `"iVBORw0KGgoAAAANS…"` |
| `filename`\*           | Dateiname des Anhangs                | `"logo.png"`           |

`references`

Die `references` Mit diesem Array können Sie einen Entwurf an eine bestehende Unterhaltung anhängen. Wenn bereits eine Unterhaltung existiert und eine E-Mail mit einem `Message-ID: <a@a.com>` oder `References: <a@a.com>` Header enthält, können Sie `"references": ["<a@a.com>"]` zu Ihrer Anfrage hinzufügen, damit der Entwurf an diese Unterhaltung angehängt wird.

Wenn die in der Anfrage übergebenen references mit mehr als einer Unterhaltung verknüpft sind, wird der Entwurf an die zuerst gefundene Unterhaltung angehängt. Wenn keine reference angegeben wird, wird der Entwurf in einer neuen Unterhaltung erstellt. Wenn eine oder mehrere references angegeben werden, aber keine davon mit einer bestehenden Unterhaltung übereinstimmt, wird der Entwurf in einer neuen Unterhaltung erstellt.

Spitzenklammern um references sind optional. Beide `["<some-reference-123>"]` und `["some-reference-123"]` würden auf dieselbe Unterhaltung verweisen.

`conversation`

Wenn Sie die ID einer bestehenden Missive-Unterhaltung kennen, in der Sie Ihren Entwurf erstellen möchten, können Sie sie als `conversation` anstatt `references`.

`subject`

Die `subject` wird unverändert an die ausgehende E-Mail übergeben. Wenn Sie auf eine bestehende E-Mail-Unterhaltung antworten, setzen Sie immer `subject` zu `Re: [the original subject]`. E-Mail-Clients wie Gmail verwenden den Betreffabgleich für die Threading-Funktion — ein leerer oder nicht übereinstimmender Betreff führt dazu, dass die Antwort beim Empfänger als neuer Thread erscheint, obwohl sie in Missive korrekt gruppiert ist.

{% hint style="info" %}
Die `references` und `conversation` werden von Missive nur verwendet, um die richtige Unterhaltung zu finden. Sie steuern nicht die `References` Header. Sobald die Unterhaltung identifiziert ist, setzt Missive automatisch den passenden `In-Reply-To` und `References` E-Mail-Header basierend auf der neuesten E-Mail in der Unterhaltung.
{% endhint %}

`team`

`team` ermöglicht es Ihnen, die Unterhaltung des Entwurfs einem Team zuzuordnen. Wenn eine Unterhaltung bereits einem Team zugeordnet ist, wird dieses Feld ignoriert.

`force_team`

`force_team` ermöglicht es Ihnen, ein neues Team zu erzwingen, auch wenn die Unterhaltung bereits in einem anderen Team ist.

`Organisation`

`Organisation` ermöglicht es Ihnen, die Suche nach Unterhaltungen auf solche zu beschränken, die bereits einer Organisation zugeordnet sind. Wenn eine neue Unterhaltung erstellt wird und `Organisation` übergeben wird, wird die neue Unterhaltung dieser Organisation zugeordnet.

`Nutzer hinzufügen`

`Nutzer hinzufügen` bestimmt die Nutzer, die Zugriff auf die Unterhaltung erhalten. Beim Übergeben von `Nutzer hinzufügen`, angeben, `Organisation` ist das Feld erforderlich.

`Zugewiesene Personen hinzufügen`

`Zugewiesene Personen hinzufügen` ermöglicht es Ihnen, Nutzer der Unterhaltung zuzuweisen. Vorhandene zugewiesene Personen bleiben zugewiesen. Beim Übergeben von `Zugewiesene Personen hinzufügen`, angeben, `Organisation` ist das Feld erforderlich.

`remove_assignees`

`remove_assignees` ermöglicht es Ihnen, zugewiesene Personen aus der Unterhaltung zu entfernen. Beim Übergeben von `remove_assignees`, angeben, `Organisation` ist das Feld erforderlich.

`add_shared_labels, remove_shared_labels`

`geteilte Labels hinzufügen` und `remove_shared_labels` ermöglichen es Ihnen, geteilte Labels zu verwalten, die auf die Unterhaltung des Entwurfs angewendet werden.

`Zum Team-Posteingang hinzufügen`

`Zum Team-Posteingang hinzufügen` ermöglicht es Ihnen, die Unterhaltung des Entwurfs in einen Team-Posteingang zu verschieben. Beim Übergeben von `Zum Team-Posteingang hinzufügen`, angeben, `team` ist das Feld erforderlich.

`Zum Posteingang hinzufügen`

`Zum Posteingang hinzufügen` ermöglicht es Ihnen, die Unterhaltung des Entwurfs in den Posteingang für alle Personen mit Zugriff auf die Unterhaltung zu verschieben.

`Erledigen`

`Erledigen` ermöglicht es Ihnen, die Unterhaltung des Entwurfs für alle Personen mit Zugriff auf die Unterhaltung als erledigt zu markieren.

`external_response_id, external_response_variables`

`external_response_id` und `external_response_variables` werden für WhatsApp-Vorlagen verwendet. Sie sind erforderlich, wenn Sie eine WhatsApp-Unterhaltung mit einem Nutzer beginnen, mit dem Sie in den letzten 24 Stunden noch nicht interagiert haben.

`external_response_id` ist die Twilio- oder Meta-ID der Vorlage, die Sie verwenden. Sie finden diese entweder im Twilio Content Template Builder oder im WhatsApp Manager. Im WhatsApp Manager wird die Meta-ID nicht in der Vorlagenliste angezeigt -- sie erscheint nur in der URL, wenn Sie eine bestimmte Vorlage öffnen:

```
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
```

Der Wert nach `template-details&childRoute=CAPI&id=` (z. B. `2222222222222222`) ist die Meta-ID, die Sie als `external_response_id`.

`external_response_variables` ist ein Objekt, bei dem die Schlüssel die Platzhalter in der Vorlage sind und die Werte der Inhalt, den Sie für den jeweiligen Platzhalter verwenden möchten. Achten Sie darauf, String-Schlüssel für alle Variablen anzugeben. Nur Textkörper-Variablen (`{{1}}`, `{{2}}`, etc.) werden unterstützt -- Vorlagen mit Medien-Headern (Dokumente, Bilder oder andere Medien, die in Meta als Header-Komponente definiert sind) können nicht über Missive gesendet werden.

{% hint style="warning" %}
Wenn Sie eine Vorlage verwenden, müssen Sie einen `body` bereitstellen, der dem Ergebnis der Vorlageninterpolation im Draft-Payload entspricht. Missive zeigt den von Ihnen angegebenen Textkörper an, sendet die Vorlage und die Variablen jedoch an den entsprechenden Anbieter.
{% endhint %}

### Eine Nachricht senden

Um eine neue Nachricht oder eine Antwort zu senden, verwenden Sie Entwurf erstellen mit dem `send: true` Parameter übergeben.

{% code title="Anfrage-Payload" %}

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

{% endcode %}

### Anwendungsfall: Automatisierte E-Mail-Sequenzen

Kombinieren Sie die API mit [automatischen Follow-up-Regeln](https://missiveapp.com/docs/advanced-features/rules/templates/automatic-follow-ups) um Drip-Kampagnen zu erstellen, die durch externe Ereignisse ausgelöst werden (z. B. Formularübermittlungen, CRM-Aktualisierungen).

**So funktioniert’s:**

1. Erstellen Sie eine Regel für ausgehende Nachrichten, die bei einer bestimmten Phrase in Ihrem E-Mail-Text ausgelöst wird
2. Fügen Sie [steps](https://missiveapp.com/docs/advanced-features/rules/steps) der Regel hinzu. Jeder Schritt wartet, prüft **Nicht beantwortet** bei den Empfängern und sendet ein Follow-up mit **Vorlage senden**
3. Verwenden Sie die API, um die erste E-Mail mit dieser Trigger-Phrase zu senden
4. Die Schritte senden die Follow-up-E-Mails (z. B. 1, 3 und 7 Tage später)
5. Wenn ein Empfänger antwortet, werden die nächsten Follow-ups nicht gesendet

**Beispiel: Website-Formular löst E-Mail-Sequenz aus**

{% code title="Anfrage-Payload" %}

```json
{
  "drafts": {
    "send": true,
    "subject": "Danke für Ihr Interesse!",
    "body": "Hallo! Hier ist das von Ihnen angeforderte Angebot...",
    "to_fields": [{ "address": "lead@example.com" }],
    "from_field": { "address": "sales@yourcompany.com" }
  }
}
```

{% endcode %}

Die Phrase „Hier ist das von Ihnen angeforderte Angebot“ löst Ihre Follow-up-Regel aus, die die Folge der Follow-up-E-Mails startet.

### Einen Entwurf löschen

`DELETE /v1/drafts/:id`

Löscht einen Entwurf aus einer Unterhaltung. Der `:id` Parameter ist die ID des Entwurfs (zurückgegeben in der Antwort von Entwurf erstellen).

***

## Nachrichten

### Eine Nachricht erstellen

`POST /v1/messages`

Erstellen Sie eine eingehende Nachricht in einem benutzerdefinierten Kanal. Benutzerdefinierte Kanäle ermöglichen es Nutzern, Nachrichtenanbieter zu integrieren, die nicht in Missive integriert sind.

{% hint style="warning" %}
Dieser Endpoint ist nur für **benutzerdefinierte Kanäle**. Er erstellt eingehende Nachrichten (simuliert von einem externen System empfangene Nachrichten).

**Um auf eine E-Mail zu antworten oder eine neue E-Mail zu senden**, verwenden Sie den [Drafts-Endpoint](#drafts) mit `send: true` stattdessen.
{% endhint %}

{% code title="Anfrage-Payload" %}

```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": "Hallo <b>Welt</b>!"
  }
}
```

{% endcode %}

**Attribute**

| Name (\* erforderlich)            | Beschreibung                                                                                                                                                         | Beispiel                                                                                                                                         |
| --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Konto`\*                         | Konto-ID. Sie finden diese ID in den Einstellungen des benutzerdefinierten Kanals.                                                                                   | `"fbf74c47-d0a0-4d77-bf3c-2118025d8102"`                                                                                                         |
| `subject`                         | Nur E-Mail-Kanal: String                                                                                                                                             | `"Hello"`                                                                                                                                        |
| `body`                            | HTML- oder Text-String basierend auf dem Nachrichtentyp des Kanals.                                                                                                  | `"<b>World!</b>"`                                                                                                                                |
| `from_field`\*                    | E-Mail-Kanal: Objekt mit `"address"` und `"name"` Schlüsseln. Text- oder HTML-Kanal: Objekt mit `"id"`, `"username"` und `"name"` Schlüssel.                         | `{ "address": "philippe@missiveapp.com", "name": "Philippe Lehoux" }` oder `{ "id": "12345", "username": "@missiveapp", "name": "Missive" }`     |
| `to_fields`                       | E-Mail-Kanal: Array von Objekten mit `"address"` und `"name"` Schlüsseln. Text- oder HTML-Kanal: Array von Objekten mit `"id"`, `"username"` und `"name"` Schlüssel. | `[{ "address": "philippe@missiveapp.com", "name": "Philippe Lehoux" }]` oder `[{ "id": "12345", "username": "@missiveapp", "name": "Missive" }]` |
| `cc_fields`                       | Nur E-Mail-Kanal: Array von Objekten mit `"address"` und `"name"` Schlüssel.                                                                                         | `[{ "address": "philippe@missiveapp.com", "name": "Philippe Lehoux" }]`                                                                          |
| `bcc_fields`                      | Nur E-Mail-Kanal: Array von Objekten mit `"address"` und `"name"` Schlüssel.                                                                                         | `[{ "address": "philippe@missiveapp.com", "name": "Philippe Lehoux" }]`                                                                          |
| `delivered_at`                    | Zeitstempel der Zustellung der Nachricht. Wenn weggelassen, wird die Nachricht zum Zeitpunkt der Anfrage als zugestellt markiert.                                    | `1563806347`                                                                                                                                     |
| `attachments`                     | Array mit Dateien, siehe unten für Details.                                                                                                                          | `[{ "base64_data": "iVBORw0KGgoAAAANS...", "filename": "logo.png" }]`                                                                            |
| `external_id`                     | Eindeutige ID zur Identifizierung von Nicht-E-Mail-Nachrichten (SMS, Instagram-DMs usw.).                                                                            | `"some-id-123"`                                                                                                                                  |
| `references`                      | Array von Strings zum Anhängen an eine bestehende Unterhaltung.                                                                                                      | `["some-reference-123"]`                                                                                                                         |
| `conversation`                    | Unterhaltungs-ID-String zum Anhängen an eine bestehende Unterhaltung                                                                                                 | `"5bb24363-69e5-48ed-80a9-feee988bc953"`                                                                                                         |
| `team`                            | Team-ID-Zeichenkette                                                                                                                                                 | Standard basierend auf den Freigabeeinstellungen des Kanals: Posteingang oder Team-Posteingang                                                   |
| `force_team`                      | boolean                                                                                                                                                              | `false`                                                                                                                                          |
| `Organisation`                    | Organisations-ID-String                                                                                                                                              | `"90beb742-27a3-44cf-95bc-7e5097167c9d"`                                                                                                         |
| `Nutzer hinzufügen`               | Array von Benutzer-ID-Strings                                                                                                                                        | `["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]`                                                                                                       |
| `Zugewiesene Personen hinzufügen` | Array von Benutzer-ID-Strings                                                                                                                                        | `["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]`                                                                                                       |
| `remove_assignees`                | Array von Benutzer-ID-Strings                                                                                                                                        | `["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]`                                                                                                       |
| `conversation_subject`            | string                                                                                                                                                               | `"Neuer Nutzer!"`                                                                                                                                |
| `Unterhaltungsfarbe`              | HEX-Farbcode oder `„gut“` `„Warnung“` `„Gefahr“` string                                                                                                              | `"#000"`, `„Gefahr“`                                                                                                                             |
| `geteilte Labels hinzufügen`      | Array von Zeichenketten mit geteilten Label-IDs                                                                                                                      | `["9825718b-3407-40b8-800d-a27361c86102"]`                                                                                                       |
| `remove_shared_labels`            | Array von Zeichenketten mit geteilten Label-IDs                                                                                                                      | `["e4aae78f-e932-40a2-9ece-ed764aa85790"]`                                                                                                       |
| `Zum Posteingang hinzufügen`      | boolean                                                                                                                                                              | Standard basierend auf den Freigabeeinstellungen des Kanals: Posteingang oder Team-Posteingang                                                   |
| `Zum Team-Posteingang hinzufügen` | boolean                                                                                                                                                              | Standard basierend auf den Freigabeeinstellungen des Kanals: Posteingang oder Team-Posteingang                                                   |
| `Erledigen`                       | boolean                                                                                                                                                              | `false`                                                                                                                                          |

`attachments`

Die `attachments` Mit diesem Array können Sie Dateien an Nachrichten anhängen. Die gesamte JSON-Payload Ihrer Anfrage darf 10 MB nicht überschreiten.

| Name (\* erforderlich) | Beschreibung                         | Beispiel                 |
| ---------------------- | ------------------------------------ | ------------------------ |
| `base64_data`\*        | Der base64-kodierte Inhalt der Datei | `"iVBORw0KGgoAAAANS..."` |
| `filename`\*           | Dateiname des Anhangs                | `"logo.png"`             |

`references`

Die `references` Mit diesem Array können Sie eine Nachricht an eine bestehende Unterhaltung anhängen. Wenn bereits eine Unterhaltung existiert und eine Nachricht mit einem `external_id: "some-id-123"` oder `references: ["some-id-123"]`, Sie können hinzufügen `"references": ["some-id-123"]` zu Ihrer Anfrage, damit die Nachricht an diese Unterhaltung angehängt wird.

Wenn die in der Anfrage übergebenen Verweise zu mehr als einer Unterhaltung gehören, wird die Nachricht an die zuerst gefundene Unterhaltung angehängt. Wenn kein Verweis angegeben ist, wird die Nachricht in einer neuen Unterhaltung erstellt. Wenn ein oder mehrere Verweise angegeben sind, aber keiner davon mit einer vorhandenen Unterhaltung übereinstimmt, wird die Nachricht in einer neuen Unterhaltung erstellt.

`conversation`

Wenn Sie die ID einer vorhandenen Missive-Unterhaltung kennen, in der Sie Ihre Nachricht erstellen möchten, können Sie sie als `conversation` anstatt `references`.

`team`

`team` Damit können Sie die Unterhaltung der Nachricht mit einem Team verknüpfen. Wenn eine Unterhaltung bereits mit einem Team verknüpft ist, wird dieses Feld ignoriert.

`force_team`

`force_team` ermöglicht es Ihnen, ein neues Team zu erzwingen, auch wenn die Unterhaltung bereits in einem anderen Team ist.

`Organisation`

`Organisation` ermöglicht es Ihnen, die Suche nach Unterhaltungen auf solche zu beschränken, die bereits einer Organisation zugeordnet sind. Wenn eine neue Unterhaltung erstellt wird und `Organisation` Wenn es übergeben wird, wird die Nachricht dieser Organisation zugeordnet.

`Nutzer hinzufügen`

`Nutzer hinzufügen` bestimmt die Nutzer, die Zugriff auf die Unterhaltung erhalten. Beim Übergeben von `Nutzer hinzufügen`, angeben, `Organisation` ist das Feld erforderlich.

`Zugewiesene Personen hinzufügen`

`Zugewiesene Personen hinzufügen` ermöglicht es Ihnen, Nutzer der Unterhaltung zuzuweisen. Vorhandene zugewiesene Personen bleiben zugewiesen. Beim Übergeben von `Zugewiesene Personen hinzufügen`, angeben, `Organisation` ist das Feld erforderlich.

`remove_assignees`

`remove_assignees` ermöglicht es Ihnen, zugewiesene Personen aus der Unterhaltung zu entfernen. Beim Übergeben von `remove_assignees`, angeben, `Organisation` ist das Feld erforderlich.

`add_shared_labels, remove_shared_labels`

`geteilte Labels hinzufügen` und `remove_shared_labels` ermöglichen es Ihnen, Geteilte Labels zu verwalten, die auf die Unterhaltung der Nachricht angewendet werden.

`Zum Team-Posteingang hinzufügen`

`Zum Team-Posteingang hinzufügen` ermöglicht es Ihnen, die Unterhaltung der Nachricht in einen Team-Posteingang zu verschieben. Wenn Sie angeben `Zum Team-Posteingang hinzufügen`, angeben, `team` ist das Feld erforderlich.

`Zum Posteingang hinzufügen`

`Zum Posteingang hinzufügen` ermöglicht es Ihnen, die Unterhaltung der Nachricht für alle mit Zugriff auf die Unterhaltung in den Posteingang zu verschieben.

`Erledigen`

`Erledigen` ermöglicht es Ihnen, die Unterhaltung der Nachricht für alle mit Zugriff auf die Unterhaltung als erledigt zu markieren.

### Nachricht abrufen

`GET /v1/messages/:id`

Ruft die Header, den Inhalt und die Anhänge einer bestimmten Nachricht mithilfe der Nachricht ab `id`.

Um mehrere Nachrichten mit einem einzigen Aufruf abzurufen, übergeben Sie durch Kommas getrennte Nachrichten-IDs:

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

{% code title="Antwort für eine einzelne Nachricht" %}

```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": "Eine Nachricht",
      "Organisation": {
        "id": "93e5e5d5-11a2-4c9b-80b8-94f3c08068cf",
        "name": "Fellowship"
      },
      "team": {
        "id": "2f618f9e-d3d4-4a01-b7d5-57124ab366b8",
        "name": "Hobbits",
        "organization": "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",
      "Nutzer": [
        {
          "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 %}

Wenn Sie mehrere Nachrichten mit durch Kommas getrennten IDs abrufen, gibt die Antwort ein Array von Nachrichtenobjekten unter dem `messages` Schlüssel im gleichen Format zurück, wie oben gezeigt.

Inline-Bilder

Inline-Bilder-Markup in der Nachricht `body` HTML enthält kein `src` Attribut, stattdessen enthalten sie ein `data-missive-attachment-id` Attribut mit dem Anhang `id`. Der Anhang und seine URL sind in der GET-Antwort unter dem `attachments` Schlüssel.

### Nachrichten auflisten

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

Nachrichten abrufen, die mit einer E-Mail übereinstimmen `Message-ID`.

{% code title="Vorlage" %}

```json
{
  "messages": [
    {
      // Neueste Nachricht
    },
    {
      // Vorletzte Nachricht
    }
  ]
}
```

{% endcode %}

Nachrichtendaten enthalten Header, Body und Anhänge im selben Format wie Nachricht abrufen.

Meistens entspricht nur eine Nachricht einer bestimmten Message-ID, wie es die E-Mail-Standards vorsehen. Nicht konforme Absenderserver können Ihnen jedoch mehrere Nachrichten mit derselben Message-ID senden; in diesem Fall gibt dieser endpoint die neuesten 10 zurück.

**Parameter**

| Name (\* erforderlich) | Standard | Beschreibung                                      |
| ---------------------- | -------- | ------------------------------------------------- |
| `email_message_id`\*   | \`\`     | Die `Message-ID` im Header einer E-Mail gefunden. |

***

## Organisationen

### Organisationen auflisten

`GET /v1/organizations`

Listen Sie die Organisationen auf, denen der authentifizierte Benutzer angehört.

{% code title="Vorlage" %}

```json
{
  "Organisationen": [
    {
      "id": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92",
      "name": "Conference Badge"
    }
  ]
}
```

{% endcode %}

**Parameter**

| Name (\* erforderlich) | Standard | Beschreibung                                                  |
| ---------------------- | -------- | ------------------------------------------------------------- |
| `limit`                | `50`     | Anzahl der zurückgegebenen Organisationen. Maximalwert: `200` |
| `offset`               | `0`      | Versatz für die Paginierung.                                  |

**Organisationseigenschaften**

| Name (\* immer vorhanden) | Beschreibung      |
| ------------------------- | ----------------- |
| `id`\*                    | Organisation-UUID |
| `name`\*                  | Organisationsname |

***

## Vorlagen

### Vorlagen auflisten

`GET /v1/Vorlagen`

Vorlagen für den authentifizierten Benutzer auflisten.

{% code title="Vorlage" %}

```json
{
  "Vorlagen": [
    {
      "id": "75ad834a-9bd6-4008-b9e6-fc9fa2e7770b",
      "title": "A test response",
      "body": "<div>Inline-Bild: <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,
      "Organisation": "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 %}

**Parameter**

| Name (\* erforderlich) | Standard | Beschreibung                                            |
| ---------------------- | -------- | ------------------------------------------------------- |
| `Organisation`         | `null`   | Organisation-ID                                         |
| `limit`                | `50`     | Anzahl der zurückgegebenen Vorlagen. Maximalwert: `200` |
| `offset`               | `0`      | Versatz für die Paginierung.                            |

Inline-Bilder

Inline-Bilder-Markup in der Vorlage `body` HTML enthält kein `src` Attribut, stattdessen enthalten sie ein `data-missive-attachment-id` Attribut mit dem Anhang `id`. Der Anhang und seine URL sind in der GET-Antwort unter dem `attachments` Schlüssel.

**Vorlageneigenschaften**

Die gleiche Form wird von [Vorlagen auflisten](#list-responses), [Eine Vorlage abrufen](#get-a-response), [Vorlage(n) erstellen](#create-response-s), und [Vorlage(n) aktualisieren](#update-response-s).

| Name (\* immer vorhanden) | Beschreibung                                              |
| ------------------------- | --------------------------------------------------------- |
| `id`\*                    | Vorlagen-UUID                                             |
| `title`\*                 | Vorlagentitel                                             |
| `body`\*                  | HTML-Text der Vorlage                                     |
| `subject`                 | Betreffzeile                                              |
| `modified_at`\*           | Unix-Zeitstempel, wann die Vorlage zuletzt geändert wurde |
| `Organisation`            | Organisation-UUID                                         |
| `Benutzer`                | Benutzer-UUID für persönliche Vorlagen                    |
| `share_with_team`         | Team-UUID, wenn auf ein Team beschränkt                   |
| `geteilte Labels`\*       | Array von UUIDs geteilter Labels                          |
| `to_fields`\*             | Array von Empfängerobjekten (`address`, `name`)           |
| `cc_fields`\*             | Array von CC-Empfängerobjekten                            |
| `bcc_fields`\*            | Array von BCC-Empfängerobjekten                           |
| `attachments`\*           | Array von Anhang-Objekten (siehe Anhang-Eigenschaften)    |
| `external_id`             | Externe Kennung                                           |
| `external_source`         | Kennung der externen Quelle                               |

### Eine Vorlage abrufen

`GET /v1/responses/:id`

Eine bestimmte Vorlage mithilfe der Vorlage abrufen `id`.

### Vorlage(n) erstellen

`POST /v1/responses`

{% code title="Anfrage-Payload" %}

```json
{
  "Vorlagen": [
    {
      "title": "Willkommens-E-Mail-Vorlage",
      "body": "<p>Willkommen bei unserem Service!</p>",
      "Organisation": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92",
      "subject": "Welcome!",
      "external_id": "template-001",
      "external_source": "knowledge-base"
    }
  ]
}
```

{% endcode %}

Eine erfolgreiche Anfrage gibt neu erstellte Vorlagen zurück.

{% code title="Vorlage" %}

```json
{
  "Vorlagen": [
    {
      "id": "75ad834a-9bd6-4008-b9e6-fc9fa2e7770b",
      "title": "Willkommens-E-Mail-Vorlage",
      "body": "<p>Willkommen bei unserem Service!</p>",
      "subject": "Welcome!",
      "Organisation": "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 %}

**Attribute**

| Name (\* erforderlich) | Beschreibung                                                                                                                                               | Beispiel                                                            |
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `title`                | Vorlagen-Titel string (maximal 500 Zeichen)                                                                                                                | `"Willkommens-E-Mail-Vorlage"`                                      |
| `Organisation`         | Organisation-ID string. Entweder `Organisation` oder `Benutzer` ist erforderlich (aber nicht beides).                                                      | `"0d9bab85-a74f-4ece-9142-0f9b9f36ff92"`                            |
| `Benutzer`             | Zeichenfolge der Benutzer-ID für persönliche Vorlagen. Entweder `Organisation` oder `Benutzer` ist erforderlich (aber nicht beides).                       | `"a41a00fd-453d-49d7-a487-9765c35a3b70"`                            |
| `body`                 | HTML-Zeichenfolge mit dem Inhalt der Vorlage                                                                                                               | `"<p>Hallo!</p>"`                                                   |
| `subject`              | Zeichenfolge für die Betreffzeile (max. 500 Zeichen)                                                                                                       | `"Willkommen!"`                                                     |
| `share_with_team`      | Zeichenfolge der Team-ID, um die Vorlage mit einem bestimmten Team zu teilen. `Organisation` ist erforderlich                                              | `"646bb7f1-2066-40be-b8f6-bacb8b3b7419"`                            |
| `geteilte Labels`      | Array von Zeichenfolgen mit geteilten Label-IDs. `Organisation` ist erforderlich                                                                           | `["9825718b-3407-40b8-800d-a27361c86102"]`                          |
| `to_fields`            | Array von Objekten mit `"address"` und `"name"` Schlüssel                                                                                                  | `[{"address": "support@example.com", "name": "Support"}]`           |
| `cc_fields`            | Array von Objekten mit `"address"` und `"name"` Schlüssel                                                                                                  | `[{"address": "manager@example.com", "name": "Manager"}]`           |
| `bcc_fields`           | Array von Objekten mit `"address"` und `"name"` Schlüssel                                                                                                  | `[{"address": "archive@example.com"}]`                              |
| `external_id`          | Externe Kennungszeichenfolge zum Synchronisieren mit anderen Systemen. Wenn angegeben, `external_source` ist erforderlich.                                 | `"template-001"`                                                    |
| `external_source`      | Kennungszeichenfolge des Quellsystems. Erforderlich, wenn `external_id` angegeben ist. Die Kombination muss pro Organisation oder Benutzer eindeutig sein. | `"knowledge-base"`                                                  |
| `attachments`          | Array mit Dateien, siehe unten für Details                                                                                                                 | `[{"base64_data": "iVBORw0KGgoAAAANS...", "filename": "logo.png"}]` |

`attachments`

Die `attachments` array ermöglicht es Ihnen, Dateien an die response anzuhängen. Die gesamte JSON payload Ihrer Anfrage darf 10 MB nicht überschreiten.

| Name (\* erforderlich) | Beschreibung                                                               | Beispiel                 |
| ---------------------- | -------------------------------------------------------------------------- | ------------------------ |
| `base64_data`\*        | Der base64-kodierte Inhalt der Datei                                       | `"iVBORw0KGgoAAAANS..."` |
| `filename`\*           | Dateiname des Anhangs                                                      | `"logo.png"`             |
| `id`                   | Temporäre ID für Inline-Bildverweise (siehe Abschnitt Inline-Bilder unten) | `"img1"`                 |

Inline-Bilder

Um Bilder inline im response body einzubetten, verwenden Sie eine temporäre `id` im Anhang und verweisen Sie im HTML mithilfe des `data-missive-attachment-id` Attribut:

{% code title="Anfrage-Payload" %}

```json
{
  "Vorlagen": [
    {
      "title": "Response with inline image",
      "Organisation": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92",
      "body": "<p>See our 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 %}

Der Server wird das Temporäre ersetzen `id` mit der tatsächlichen UUID des Anhangs. Anhänge mit einer `id` Alles, was im HTML-Body referenziert wird, wird als Inline-Bilder behandelt; Anhänge ohne Verweis im Body werden als normale Anhänge behandelt.

### Vorlage(n) aktualisieren

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

Eine erfolgreiche Anfrage gibt die aktualisierten Vorlagen zurück.

{% code title="Anfrage-Payload" %}

```json
{
  "Vorlagen": [
    {
      "id": "75ad834a-9bd6-4008-b9e6-fc9fa2e7770b",
      "title": "Aktualisierte Willkommensvorlage",
      "body": "<p>Hallo {{name}},</p><p>Willkommen an Bord!</p>"
    }
  ]
}
```

{% endcode %}

**Attribute**

Vorlage `id` ist erforderlich. Weitere Attribute finden Sie im Abschnitt „Vorlagen erstellen“. Wenn Sie eine Vorlage aktualisieren, können Sie nur die Attribute übergeben, die Sie aktualisieren möchten. Im obigen Beispiel werden nur Titel und Inhalt aktualisiert.

{% hint style="warning" %}
Wenn die `attachments` Wenn ein array übergeben wird, müssen Sie alle Anhänge übergeben, die Sie behalten möchten. Fehlende Anhänge werden aus der Antwort entfernt.
{% endhint %}

{% hint style="info" %}
Von externen Integrationen erstellte Vorlagen (wie etwa WhatsApp-Vorlagen) können über diesen Endpoint nicht aktualisiert werden.
{% endhint %}

### Vorlage löschen

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

Löscht eine oder mehrere Vorlagen.

Für Organisationsvorlagen in Organisationen mit aktivierter eingeschränkter Vorlagenverwaltung (Feature des Enterprise-Plans) haben nur Organisations-Admins und -Eigentümer die Berechtigung, Vorlagen zu löschen.

{% hint style="info" %}
Von externen Integrationen erstellte Vorlagen (z. B. WhatsApp-Vorlagen) können über diesen Endpoint nicht gelöscht werden.
{% endhint %}

***

## Beiträge

Der Posts-Endpoint ermöglicht es Ihnen, Daten in jede Missive-Unterhaltung einzufügen und den Status der Unterhaltung zu verwalten. Sie können Posts in Neue Unterhaltungen erstellen oder sie an bestehende Unterhaltungen anhängen.

Posts sind die empfohlene Möglichkeit, Unterhaltungen zu verwalten (als erledigt markieren, in den Posteingang verschieben, Nutzern zuweisen, Labels hinzufügen) über Integrationen und Automatisierungen. Jeder Post hinterlässt eine sichtbare Spur in der Unterhaltung und zeigt, was die Aktion ausgelöst hat.

Beispielverwendung: Jedes Mal, wenn jemand Code auf Github pusht, erstellen Sie einen Beitrag, der die Commits auflistet. Wenn ein Support-Ticket in Ihrem System gelöst wird, erstellen Sie einen Beitrag, der die Unterhaltung als erledigt markiert.

### Unterhaltungen mit Beiträgen verwalten

Verwenden Sie Beiträge, um Aktionen für Unterhaltung auszuführen und gleichzeitig eine Spur zu hinterlassen, die zeigt, welche Integration die Änderung ausgelöst hat. Hier sind häufige Aktionen:

| Zu erledigen                                           | Verwenden Sie diese Parameter                   |
| ------------------------------------------------------ | ----------------------------------------------- |
| Eine Unterhaltung als erledigt markieren               | `close: true`                                   |
| Eine Unterhaltung wieder öffnen                        | `reopen: true`                                  |
| In den Posteingang verschieben (Archivierung aufheben) | `add_to_inbox: true`                            |
| In Team-Posteingang verschieben                        | `add_to_team_inbox: true` und `team: "team-id"` |
| Nutzer zuweisen                                        | `add_assignees: ["user-id"]`                    |
| Zugewiesene entfernen                                  | `remove_assignees: ["user-id"]`                 |
| Labels hinzufügen                                      | `add_shared_labels: ["label-id"]`               |
| Labels entfernen                                       | `remove_shared_labels: ["label-id"]`            |
| Farbe der Unterhaltung festlegen                       | `conversation_color: "#ff0000"`                 |
| Team wechseln                                          | `team: "team-id"` und `force_team: true`        |

{% hint style="warning" %}
**Archivieren nicht verfügbar**: Derzeit gibt es keinen Parameter, um Unterhaltungen über die API zu archivieren.
{% endhint %}

**Beispiel: Unterhaltung mit einem benutzerdefinierten Beitrag als erledigt markieren**

{% code title="Anfrage" %}

```json
{
  "posts": {
    "conversation": "00f78fe9-f11a-4b4e-a502-67e6138d3b0f",
    "notification": {
      "title": "Ticket gelöst",
      "body": "Dieses Support-Ticket wurde als gelöst markiert"
    },
    "username": "Support System",
    "text": "Ticket #1234 wurde gelöst und als erledigt markiert.",
    "close": true
  }
}
```

{% endcode %}

Dies erstellt einen Beitrag in der Unterhaltung und markiert sie als erledigt. Teammitglieder sehen den Beitrag, der erklärt, warum die Unterhaltung als erledigt markiert wurde.

### Einen Beitrag erstellen

`POST /v1/posts`

{% code title="Anfrage-Payload" %}

```json
{
  "posts": {
    "conversation": "00f78fe9-f11a-4b4e-a502-67e6138d3b0f",
    "notification": { "title": "Ein Titel", "body": "Ein Text" },
    "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": "New customer signed up!",
        "timestamp": 1511540318
      }
    ]
  }
}
```

{% endcode %}

{% code title="Vorlage" %}

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

{% endcode %}

Die Antwort enthält:

* `conversation`: ID der Unterhaltung, zu der der Beitrag hinzugefügt wurde
* `id`: ID des Beitrags (verwenden Sie diese ID zum Löschen des Beitrags)

**Attribute**

| Name (\* erforderlich)            | Beschreibung                                                                                        | Beispiel                                                       |
| --------------------------------- | --------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
| `username`                        | Name des Beitragsautors, der anstelle des Namens des API token-Besitzers verwendet wird             | `„Missive“`                                                    |
| `username_icon`                   | Bild des Beitragsautors, das anstelle des Avatars des API token-Besitzers verwendet wird            | `"https://s3.amazonaws.com/missive-assets/missive-avatar.png"` |
| `conversation_icon`               | Bild, das als Symbol in der Unterhaltungsliste verwendet wird                                       | `"https://s3.amazonaws.com/missive-assets/missive-avatar.png"` |
| `conversation_subject`            | string                                                                                              | `"Neuer Nutzer!"`                                              |
| `Unterhaltungsfarbe`              | HEX-Farbcode oder `„gut“` `„Warnung“` `„Gefahr“` string                                             | `"#000"`, `„Gefahr“`                                           |
| `text`                            | Hauptnachricht eines Beitrags                                                                       | `"Dies ist ein Beitrag!"`                                      |
| `markdown`                        | Hauptnachricht eines Beitrags, formatiert mit Markdown                                              | `"Dies ist ein **Beitrag**!"`                                  |
| `notification`\*                  | Objekt mit den Schlüsseln „title“ und „body“, das zum Rendern einer Benachrichtigung verwendet wird | `{"title":"Ein Titel", "body": "Ein Text"}`                    |
| `attachments`                     | Array mit Anhang-Objekten, siehe unten für Details                                                  | `[{"text": "Dies ist ein Anhang!"}]`                           |
| `references`                      | Array von Strings zum Anhängen an eine bestehende Unterhaltung.                                     | `["<some-reference-123>"]`                                     |
| `conversation`                    | Unterhaltungs-ID-String zum Anhängen an eine bestehende Unterhaltung                                | `"5bb24363-69e5-48ed-80a9-feee988bc953"`                       |
| `Organisation`                    | Organisations-ID-String                                                                             | `"90beb742-27a3-44cf-95bc-7e5097167c9d"`                       |
| `team`                            | Team-ID-Zeichenkette                                                                                | `"646bb7f1-2066-40be-b8f6-bacb8b3b7419"`                       |
| `force_team`                      | boolean                                                                                             | `false`                                                        |
| `Nutzer hinzufügen`               | Array von Benutzer-ID-Strings                                                                       | `["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]`                     |
| `Zugewiesene Personen hinzufügen` | Array von Benutzer-ID-Strings                                                                       | `["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]`                     |
| `remove_assignees`                | Array von Benutzer-ID-Strings                                                                       | `["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]`                     |
| `geteilte Labels hinzufügen`      | Array von Zeichenketten mit geteilten Label-IDs                                                     | `["9825718b-3407-40b8-800d-a27361c86102"]`                     |
| `remove_shared_labels`            | Array von Zeichenketten mit geteilten Label-IDs                                                     | `["e4aae78f-e932-40a2-9ece-ed764aa85790"]`                     |
| `Zum Posteingang hinzufügen`      | boolean                                                                                             | `false`                                                        |
| `Zum Team-Posteingang hinzufügen` | boolean                                                                                             | `false`                                                        |
| `Erledigen`                       | boolean                                                                                             | `false`                                                        |
| `Wieder öffnen`                   | boolean                                                                                             | `true`                                                         |

Validierungen

* Entweder `text`, `markdown` oder `attachments` ist erforderlich.
* Die `text` und `markdown` Felder haben eine maximale Länge von 8000 Zeichen.
* Die gesamte JSON payload Ihrer Anfrage darf 10 MB nicht überschreiten.

`references`

Die `references` Array ermöglicht es Ihnen, einen Beitrag an eine bestehende Unterhaltung anzuhängen. Wenn bereits eine Unterhaltung existiert und eine E-Mail mit einer `Message-ID: <a@a.com>` oder `References: <a@a.com>` Header enthält, können Sie `"references": ["<a@a.com>"]` zu Ihrer Anfrage hinzu, damit der Beitrag an diese Unterhaltung angehängt wird.

Wenn die in der Anfrage übergebenen Referenzen mit mehr als einer Unterhaltung verknüpft sind, wird der Beitrag nur in die zuerst gefundene Unterhaltung eingefügt. Wenn keine Referenz angegeben wird, wird der Beitrag in eine neue Unterhaltung eingefügt. Wenn eine oder mehrere Referenzen angegeben werden, aber keine davon mit einer vorhandenen Unterhaltung übereinstimmt, wird der Beitrag in eine neue Unterhaltung eingefügt.

Spitzenklammern um references sind optional. Beide `["<some-reference-123>"]` und `["some-reference-123"]` würden auf dieselbe Unterhaltung verweisen.

`conversation`

Wenn Sie die ID einer vorhandenen Missive-Unterhaltung kennen, in der Sie Ihren Beitrag erstellen möchten, können Sie sie als `conversation` anstatt `references`.

`Organisation`

`Organisation` ermöglicht es Ihnen, die Suche nach Unterhaltungen auf die zu beschränken, die bereits einer Organisation zugeordnet sind. Wenn eine neue Unterhaltung erstellt wird und `Organisation` übergeben wird, wird die Unterhaltung mit dieser Organisation verknüpft.

`team`

`team` ermöglicht es Ihnen, die Unterhaltung des Beitrags einem Team zuzuordnen. Wenn eine Unterhaltung bereits mit einem Team verknüpft ist, wird dieses Feld ignoriert.

`force_team`

`force_team` ermöglicht es Ihnen, ein neues Team zu erzwingen, auch wenn die Unterhaltung bereits in einem anderen Team ist.

`Nutzer hinzufügen`

`Nutzer hinzufügen` bestimmt die Nutzer, die Zugriff auf die Unterhaltung erhalten. Beim Übergeben von `Nutzer hinzufügen`, angeben, `Organisation` ist das Feld erforderlich.

`Zugewiesene Personen hinzufügen`

`Zugewiesene Personen hinzufügen` ermöglicht es Ihnen, Nutzer der Unterhaltung zuzuweisen. Vorhandene zugewiesene Personen bleiben zugewiesen. Beim Übergeben von `Zugewiesene Personen hinzufügen`, angeben, `Organisation` ist das Feld erforderlich.

`remove_assignees`

`remove_assignees` ermöglicht es Ihnen, zugewiesene Personen aus der Unterhaltung zu entfernen. Beim Übergeben von `remove_assignees`, angeben, `Organisation` ist das Feld erforderlich.

`add_shared_labels, remove_shared_labels`

`geteilte Labels hinzufügen` und `remove_shared_labels` ermöglichen es Ihnen, Geteilte Labels zu verwalten, die auf die Unterhaltung des Beitrags angewendet werden.

`Zum Team-Posteingang hinzufügen`

`Zum Team-Posteingang hinzufügen` verschiebt die Unterhaltung in einen Team-Posteingang für alle mit Zugriff. Bei Angabe von `Zum Team-Posteingang hinzufügen`, angeben, `team` Dieses Feld ist erforderlich. Ein Hinweis auf diese Aktion wird in der Unterhaltung angezeigt.

`Zum Posteingang hinzufügen`

`Zum Posteingang hinzufügen` verschiebt die Unterhaltung für alle mit Zugriff in den Posteingang (hebt die Archivierung der Unterhaltung auf). Ein Hinweis auf diese Aktion wird in der Unterhaltung angezeigt.

`Erledigen`

`Erledigen` markiert die Unterhaltung für alle mit Zugriff als erledigt. Ein Hinweis auf diese Aktion wird in der Unterhaltung angezeigt.

`Wieder öffnen`

`Wieder öffnen` verhindert, dass erledigte Unterhaltungen beim Erstellen eines Beitrags wieder geöffnet werden. Setzen Sie es auf `true` um die Unterhaltung auch nach dem Hinzufügen des neuen Beitrags erledigt zu lassen.

`attachments`

Die `attachments` Array unterstützt zwei Arten von Anhängen:

**1. Formatierte Anhang-Blöcke** mit den folgenden Feldern:

| Name          | Beschreibung                                            | Beispiel                                        |
| ------------- | ------------------------------------------------------- | ----------------------------------------------- |
| `color`       | HEX-Farbcode oder `„gut“` `„Warnung“` `„Gefahr“` string | `"#ccc"`, `„Gefahr“`                            |
| `pretext`     | Textzeichenfolge                                        | `"Dies ist ein Vorspann!"`                      |
| `author_name` | Name des Autors des Anhangs                             | `„Benutzer - Phil“`                             |
| `author_link` | URL, die auf den Autor verlinkt                         | `"https://admin.myapp.com/users/phil"`          |
| `author_icon` | Bild-URL des Autors des Anhangs                         | `"https://myapp.com/phil.png"`                  |
| `title`       | Anhang-Titel                                            | `„Dies ist ein Titel!“`                         |
| `title_link`  | URL, die auf die Anhangsressource verweist              | `"https://myapp.com/a-resource"`                |
| `image_url`   | Bild-URL des Anhangs                                    | `"https://myapp.com/a-resource.png"`            |
| `text`        | Textzeichenfolge                                        | `"Das ist Text!"`                               |
| `markdown`    | Textzeichenfolge, formatiert mit Markdown               | `"Das ist ein **fetter Text**!"`                |
| `timestamp`   | Ganzzahliger Wert in Unix-Zeit                          | `1512395766`                                    |
| `footer`      | Textzeichenfolge                                        | `"This is a footer!"`                           |
| `footer_icon` | Bild-URL der Fußzeile des Anhangs                       | `"https://myapp.com/logo.png"`                  |
| `fields`      | Array mit Feldobjekten, Details siehe unten             | `[{"title": "Paying customer","value": "yes"}]` |

**2. Binäre Dateianhänge** im gleichen Format wie Entwürfe und Nachrichten:

| Name (\* erforderlich) | Beschreibung                         | Beispiel                 |
| ---------------------- | ------------------------------------ | ------------------------ |
| `base64_data`\*        | Der base64-kodierte Inhalt der Datei | `"iVBORw0KGgoAAAANS..."` |
| `filename`\*           | Dateiname des Anhangs                | `"logo.png"`             |

Unterstützte Inline-Darstellungsformate: JPEG, PNG, GIF (Bilder), MOV, MP4 (Video), MP3 (Audio). Andere Dateitypen werden als herunterladbare Anhänge angezeigt.

`attachments.fields`

| Name (\* erforderlich) | Beschreibung                                                                    | Beispiel             |
| ---------------------- | ------------------------------------------------------------------------------- | -------------------- |
| `title`                | Textzeichenfolge                                                                | `„Zahlender Kunde?“` |
| `value`                | Textzeichenfolge                                                                | `„ja“`               |
| `Kurz`                 | Boolean. Wenn true, gibt es zwei Felder pro Zeile, andernfalls eines pro Zeile. | `true`               |

### Einen Post löschen

`DELETE /v1/posts/:id`

Löscht einen Post aus einer Unterhaltung. Der `:id` Parameter ist die ID des Posts (zurückgegeben in der Antwort zum Erstellen eines Posts).

{% hint style="info" %}
Für Geteilte Unterhaltungen muss der API token von einem Admin in der Organisation generiert werden, die die Unterhaltung besitzt. Nur der Organisationsinhaber und Admins haben die Berechtigung, Posts in Unterhaltungen zu löschen, die mit ihrer Organisation geteilt sind.
{% endhint %}

***

## Geteilte Labels

### Geteilte Labels erstellen

`POST /v1/shared_labels`

{% code title="Anfrage-Payload" %}

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

{% endcode %}

Eine erfolgreiche Anfrage gibt neu erstellte Geteilte Labels zurück.

{% code title="Vorlage" %}

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

{% endcode %}

**Attribute**

| Name (\* erforderlich)    | Beschreibung                                        | Beispiel                                  |
| ------------------------- | --------------------------------------------------- | ----------------------------------------- |
| `name`\*                  | Label-Name string                                   | `"Heroku"`                                |
| `Organisation`\*          | Organisations-ID-String                             | `"0d9bab85-a74f-4ece-9142-0f9b9f36ff92"`  |
| `color`                   | HEX-Farbcode                                        | `"#430098"`                               |
| `parent`                  | ID-Zeichenkette des übergeordneten geteilten Labels | `"9b45a00fd-353s-89l2-a487-2465c35c3r91"` |
| `Mit Organisation teilen` | Boolescher Wert                                     | `true`                                    |
| `share_with_team`         | Team-ID-Zeichenkette                                | `nil`                                     |
| `mit_Nutzer_teilen`       | Array von Benutzer-ID-Strings                       | `[]`                                      |
| `visibility`              | Entweder `'Organisation'` oder `'delegates'` string | `'Organisation'`                          |

`Mit Organisation teilen`, `share_with_team`, `mit_Nutzer_teilen`\
Nutzer, die von einem der beiden Parameter betroffen sind, haben Zugriff auf alle Unterhaltungen im Label.

`visibility`

Der Parameter visibility steuert, für wen das Label sichtbar ist. Wenn der Wert ist `Organisation`, alle in der Organisation können das Label verwenden. Wenn der Wert `Delegierte`, nur Admins und Nutzer mit automatischem Teilen (Nutzer, die von `mit_Nutzer_teilen`, `Mit Organisation teilen`, `share_with_team`) können das Label verwenden.

### Geteilte Labels aktualisieren

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

Eine erfolgreiche Anfrage gibt die aktualisierten Geteilte Labels zurück.

{% code title="Anfrage-Payload" %}

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

{% endcode %}

Attribute

Geteiltes Label `id` ist erforderlich. Weitere Attribute finden Sie im Abschnitt „Geteilte Label erstellen“. Sie können nur die Attribute übergeben, die Sie aktualisieren möchten. Im obigen Beispiel werden der Name und die Farbe aktualisiert.

Basic-Nutzer können Folgendes aktualisieren:

* `name`: Der Name des Labels
* `color`: Die Farbe des Labels als Hex-Farbcode (z. B. #f96885)
* `parent`: Die ID des übergeordneten Labels

Admin-/Besitzer-Nutzer können zusätzlich Folgendes aktualisieren:

* `visibility`: Muss entweder 'Delegierte' oder 'Organisation' sein
* `Mit Organisation teilen`: Ob das Label mit der gesamten Organisation geteilt werden soll
* `share_with_team`: Die ID des Teams, mit dem das Label geteilt werden soll
* `mit_Nutzer_teilen`: Ein Array von Benutzer-IDs, mit denen das Label geteilt wird

### Geteilte Labels auflisten

`GET /v1/shared_labels`

Geteilte Labels in Organisationen auflisten, denen der authentifizierte Benutzer angehört und auf die er Zugriff hat.

{% code title="Vorlage" %}

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

{% endcode %}

**Parameter**

| Name (\* erforderlich) | Standard | Beschreibung                                                       |
| ---------------------- | -------- | ------------------------------------------------------------------ |
| `Organisation`         | `null`   | Organisation-ID                                                    |
| `limit`                | `50`     | Anzahl der zurückgegebenen Geteilten Labels. Maximaler Wert: `200` |
| `offset`               | `0`      | Versatz für die Paginierung.                                       |

**Eigenschaften von Geteilten Labels**

Die gleiche Form wird von [Geteilte Labels auflisten](#list-shared-labels), [Geteilte Labels erstellen](#create-shared-labels-s), und [Geteilte Labels aktualisieren](#update-shared-label-s).

| Name (\* immer vorhanden)   | Beschreibung                                                                      |
| --------------------------- | --------------------------------------------------------------------------------- |
| `id`\*                      | UUID des geteilten Labels                                                         |
| `name`\*                    | Label-Name                                                                        |
| `name_with_parent_names`\*  | Vollständiger Label-Pfad einschließlich übergeordneter Namen, verbunden durch `/` |
| `Organisation`\*            | Organisation-UUID                                                                 |
| `color`                     | HEX-Farbcode                                                                      |
| `parent`                    | UUID des übergeordneten Labels                                                    |
| `Mit Organisation teilen`\* | Ob das Label mit allen in der Organisation geteilt ist                            |
| `share_with_team`           | Team-UUID, wenn mit einem bestimmten Team geteilt                                 |
| `mit_Nutzer_teilen`\*       | Array von Benutzer-UUIDs, mit denen das Label explizit geteilt ist                |
| `visibility`\*              | `Organisation` oder `Delegierte`                                                  |

***

## Teams

### Teams auflisten

`GET /v1/teams`

Teams in Organisationen auflisten, denen der authentifizierte Nutzer angehört und auf die er Zugriff hat.

{% code title="Vorlage" %}

```json
{
  "teams": [
    {
      "id": "d75aecb6-96a2-4b5f-afa6-19d1916052ea",
      "name": "Sales",
      "Organisation": "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 %}

**Parameter**

| Name (\* erforderlich) | Standard | Beschreibung                                         |
| ---------------------- | -------- | ---------------------------------------------------- |
| `Organisation`         | `null`   | Organisation-ID                                      |
| `limit`                | `50`     | Anzahl der zurückgegebenen Teams. Maximalwert: `200` |
| `offset`               | `0`      | Versatz für die Paginierung.                         |

### Team(s) erstellen

`POST /v1/teams`

Erstellen Sie ein Neues Team in einer Organisation. Der API token muss einem Admin oder Inhaber der Organisation gehören.

{% tabs %}
{% tab title="Einfach" %}
{% code title="Anfrage-Payload" %}

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

{% endcode %}
{% endtab %}

{% tab title="Vollständiges Beispiel" %}
{% code title="Anfrage-Payload" %}

```json
{
  "teams": [
    {
      "name": "Support",
      "Organisation": "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="Vorlage" %}

```json
{
  "teams": [
    {
      "id": "d75aecb6-96a2-4b5f-afa6-19d1916052ea",
      "name": "Support",
      "emoji": ":dart:",
      "color": "#2266ED",
      "Organisation": "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 %}

**Attribute**

| Name (\* erforderlich)    | Beschreibung                                                                                   | Beispiel                                   |
| ------------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------ |
| `name`\*                  | Teamname-Zeichenfolge                                                                          | `„Support“`                                |
| `Organisation`\*          | Organisations-ID-String                                                                        | `"0d9bab85-a74f-4ece-9142-0f9b9f36ff92"`   |
| `Emoji`                   | Emoji-Kurzcodes in `:name:` Format (siehe [Emojipedia](https://emojipedia.org/) für Kurzcodes) | `":dart:"`                                 |
| `color`                   | [HEX-Farbcode](https://en.wikipedia.org/wiki/Web_colors#Hex_triplet)                           | `"#2266ED"`                                |
| `active_members`          | Array von Benutzer-ID-Strings für aktive Teammitglieder                                        | `["1ce8117e-ae42-4304-b953-c81656da4bd1"]` |
| `Beobachter`              | Array von Benutzer-ID-Strings für Beobachter des Teams                                         | `["a41a00fd-453d-49d7-a487-9765c35a3b70"]` |
| `business_hours`          | Konfigurationsobjekt für Geschäftszeiten, siehe unten für Details                              | `{"tz": "America/Montreal", "t": [...]}`   |
| `inactivity_period`       | Inaktivitätszeitraum in Sekunden, bevor eine Unterhaltung als veraltet gilt                    | `604800`                                   |
| `team_mention_behavior`   | Wer Benachrichtigungen erhält, wenn das Team erwähnt wird                                      | `"only_active_members"`                    |
| `user_reply_behavior`     | Was passiert, wenn ein Benutzer auf eine nicht zugewiesene Unterhaltung antwortet              | `"assign_user"`                            |
| `received_reply_behavior` | Wo zugewiesene Unterhaltungen angezeigt werden, wenn eine neue Antwort eingeht                 | `"show_in_assignee_inbox"`                 |
| `team_sidebar_behavior`   | Was in der Seitenleiste für dieses Team angezeigt werden soll                                  | `"show_team_space"`                        |
| `team_inbox_enabled`      | Ob der Team-Posteingang aktiviert ist                                                          | `true`                                     |
| `chat_room_enabled`       | Ob der Team-Chatraum aktiviert ist                                                             | `true`                                     |

`active_members, observers`

Aktive Mitglieder werden über Neue Nachrichten im Team-Posteingang benachrichtigt und sehen außerdem Unterhaltungen in der vereinheitlichten Ansicht der Team-Posteingänge. Beobachter werden nicht über Neue Nachrichten im Team-Posteingang benachrichtigt und sehen Unterhaltungen in der vereinheitlichten Ansicht der Team-Posteingänge nicht, können den Team-Posteingang aber bei Bedarf öffnen und verwalten. Beide erhalten Zugriff auf Kontakte, Vorlagen, Kalender und Integrationen, die mit dem Team geteilt werden.

`business_hours`

Die `business_hours` Das Objekt definiert, wann das Team verfügbar ist:

* `tz`: Kennung der Zeitzone (siehe [Liste der Zeitzonen](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List))
* `t`: Array von Zeitfenster-Objekten, die jeweils Folgendes enthalten:
  * `d`: Wochentag (0 = Sonntag, 1 = Montag, ..., 6 = Samstag)
  * `s`: Array aus zwei Ganzzahlen, die Start- und Endzeiten in Sekunden seit Mitternacht darstellen (z. B., `[32400, 61200]` = 9:00 AM bis 5:00 PM)

`inactivity_period`

Die Anzahl der Sekunden ohne Aktivität, nach denen eine Unterhaltung als inaktiv gilt. Übliche Werte: `86400` (1 Tag), `259200` (3 Tage), `604800` (1 Woche).

`team_mention_behavior`

* `all_members`: Alle Teammitglieder (aktive und Mitlesende) erhalten Benachrichtigungen, wenn das Team erwähnt wird
* `only_active_members`: Nur Aktive Mitglieder erhalten Benachrichtigungen, wenn das Team erwähnt wird

`user_reply_behavior`

* `assign_user`: Den Benutzer automatisch der Unterhaltung zuweisen, wenn er antwortet
* `Im Team-Posteingang belassen`: Unterhaltung im Team-Posteingang belassen, ohne zuzuweisen

`received_reply_behavior`

* `Im Posteingang der zugewiesenen Person anzeigen`: Im Posteingang der zugewiesenen Person anzeigen, wenn eine neue Antwort eingeht
* `show_in_team_inbox`: Zurückverschieben in den Team-Posteingang, wenn eine neue Antwort eingeht

`team_sidebar_behavior`

* `show_team_space`: Den gesamten Team-Bereich in der Seitenleiste anzeigen
* `Team-Posteingang anzeigen`: Nur den Team-Posteingang in der Seitenleiste anzeigen

### Team(s) aktualisieren

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

Aktualisieren Sie ein oder mehrere Teams. Das API token muss einem Administrator oder Inhaber der Organisation gehören.

Eine erfolgreiche Anfrage gibt die aktualisierten Teams zurück.

{% code title="Anfrage-Payload" %}

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

{% endcode %}

**Attribute**

Team `id` ist erforderlich. Siehe den Abschnitt Team(s) erstellen für weitere Attribute. Sie können nur Attribute übergeben, die Sie aktualisieren möchten. Im obigen Beispiel werden nur der Name, das Emoji und Aktive Mitglieder aktualisiert.

**Team-Eigenschaften**

Die gleiche Form wird von [Teams auflisten](#list-teams), [Team(s) erstellen](#create-team-s), und [Team(s) aktualisieren](#update-team-s).

| Name (\* immer vorhanden)   | Beschreibung                                                                |
| --------------------------- | --------------------------------------------------------------------------- |
| `id`\*                      | Team-UUID                                                                   |
| `name`\*                    | Teamname                                                                    |
| `Organisation`\*            | Organisation-UUID                                                           |
| `active_members`\*          | Array von Benutzer-UUIDs für aktive Teammitglieder                          |
| `Beobachter`\*              | Array von Benutzer-UUIDs für Beobachter des Teams                           |
| `Emoji`                     | Emoji-Kurzcode (z. B. `:dart:`)                                             |
| `color`                     | HEX-Farbcode                                                                |
| `business_hours`            | Konfigurationsobjekt für Geschäftszeiten                                    |
| `inactivity_period`         | Inaktivitätszeitraum in Sekunden, bevor eine Unterhaltung als veraltet gilt |
| `team_inbox_enabled`\*      | Ob der Team-Posteingang aktiviert ist                                       |
| `chat_room_enabled`\*       | Ob der Team-Chatraum aktiviert ist                                          |
| `team_mention_behavior`\*   | `only_active_members` oder `all_members`                                    |
| `user_reply_behavior`\*     | `assign_user` oder `Im Team-Posteingang belassen`                           |
| `received_reply_behavior`\* | `Im Posteingang der zugewiesenen Person anzeigen` oder `show_in_team_inbox` |
| `team_sidebar_behavior`\*   | `show_team_space` oder `Team-Posteingang anzeigen`                          |

***

## Nutzer

User-Endpunkte ermöglichen es Ihnen, Nutzer in Ihrer Organisation aufzulisten.

{% hint style="info" %}
Der Nutzerstatus (Verfügbarkeit, nicht anwesend, Abwesend) ist über die API nicht verfügbar. Derzeit gibt es keine Endpunkte, um den Nutzerstatus abzurufen oder zu aktualisieren.
{% endhint %}

### Nutzer auflisten

`GET /v1/users`

Nutzer in Organisationen auflisten, denen der authentifizierte Nutzer angehört.

{% code title="Vorlage" %}

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

{% endcode %}

**Parameter**

| Name (\* erforderlich) | Standard | Beschreibung                                          |
| ---------------------- | -------- | ----------------------------------------------------- |
| `Organisation`         | `null`   | Organisation-ID                                       |
| `limit`                | `50`     | Anzahl der zurückgegebenen Nutzer. Maximalwert: `200` |
| `offset`               | `0`      | Versatz für die Paginierung.                          |

**Benutzereigenschaften**

| Name (\* immer vorhanden) | Beschreibung                                                                  |
| ------------------------- | ----------------------------------------------------------------------------- |
| `id`\*                    | Benutzer-UUID                                                                 |
| `name`\*                  | Anzeigename des Benutzers                                                     |
| `email`\*                 | E-Mail des Benutzers                                                          |
| `avatar_url`\*            | URL des Benutzer-Avatars                                                      |
| `mich`                    | `true` wenn der Benutzer der Inhaber des API token ist; andernfalls weglassen |

***

## Aufgaben

Aufgaben-Endpoints ermöglichen es Ihnen, Aufgaben programmgesteuert zu erstellen und zu verwalten.

Beispielverwendung: Erstellen Sie automatisch Aufgaben aus Ihrem Projektmanagement-Tool oder Bug-Tracker.

### Aufgaben auflisten

`GET /v1/tasks`

Listet die Aufgaben auf, auf die der authentifizierte Benutzer Zugriff hat. Die Ergebnisse sind nach dem Zeitpunkt der letzten Aktivität sortiert (aktuellste zuerst) und können nach verschiedenen Kriterien gefiltert werden.

Beispielanfrage:

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

{% code title="Vorlage" %}

```json
{
  "Aufgaben": [
    {
      "id": "75ad834a-9bd6-4008-b9e6-fc9fa2e7770b",
      "conversation": null,
      "title": "Review pull request",
      "description": "Please review 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 %}

**Abfrageparameter**

| Name           | Beschreibung                                                                                      | Beispiel                                 |
| -------------- | ------------------------------------------------------------------------------------------------- | ---------------------------------------- |
| `limit`        | Anzahl der zurückzugebenden Aufgaben (min. 2, max. 50)                                            | `10`                                     |
| `bis`          | Unix-Zeitstempel für die Paginierung, gibt Aufgaben mit last\_activity\_at vor diesem Wert zurück | `1692371867`                             |
| `Organisation` | Nach Organisations-ID filtern                                                                     | `"0d9bab85-a74f-4ece-9142-0f9b9f36ff92"` |
| `team`         | Nach Team-ID filtern                                                                              | `"0e24f298-965d-4475-9220-b32636a1e2c3"` |
| `assignee`     | Nach Benutzer-ID der zugewiesenen Person filtern                                                  | `"1ce8117e-ae42-4304-b953-c81656da4bd1"` |
| `state`        | Nach Status filtern. Einer von: `todo`, `in_progress`, `Erledigt`                                 | `"todo"`                                 |
| `type`         | Nach Typ filtern. Einer von: `Aufgabe`, `conversation`, `alle`                                    | `"all"`                                  |
| `conversation` | Nach ID der übergeordneten Unterhaltung filtern (gibt Unteraufgaben dieser Unterhaltung zurück)   | `"a5d2aa1c-3828-4f90-bbd8-3dffaadda97e"` |
| `due_at_gteq`  | Aufgaben filtern nach `due_at` größer als oder gleich diesem Unix-Zeitstempel                     | `1692371867`                             |
| `due_at_lteq`  | Aufgaben filtern nach `due_at` kleiner als oder gleich diesem Unix-Zeitstempel                    | `1692400000`                             |

`type`

Aufgaben nach ihrem Typ filtern:

* `Aufgabe` - Nur Aufgaben zurückgeben (Unteraufgaben von Unterhaltungen oder eigenständige Aufgaben)
* `conversation` - Nur Unterhaltungen mit Aufgaben zurückgeben (zugewiesene oder fällige Unterhaltungen)
* `alle` - Sowohl Aufgaben als auch Unterhaltungen mit Aufgaben zurückgeben (Standard)

Paginierung

Um durch die Ergebnisse zu paginieren, verwenden Sie den `last_activity_at` Wert der letzten Aufgabe in der Antwort als den `bis` Parameter für die nächste Anfrage. Ziehen Sie 1 vom Zeitstempel ab, um Duplikate zu vermeiden, da `bis` inklusive ist.

**Aufgabeneigenschaften**

Die gleiche Form wird von [Aufgaben auflisten](#list-tasks), [Eine Aufgabe abrufen](#get-a-task), [Eine Aufgabe erstellen](#create-a-task), und [Eine Aufgabe aktualisieren](#update-a-task), und ist außerdem als das eingebettet `Aufgabe` Feld in einem Kommentar.

| Name (\* immer vorhanden) | Beschreibung                                                                                                                 |
| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `id`\*                    | Aufgaben-UUID                                                                                                                |
| `title`\*                 | Aufgabentitel                                                                                                                |
| `state`\*                 | `todo`, `in_progress`, oder `Erledigt`                                                                                       |
| `type`\*                  | `Aufgabe` oder `conversation`                                                                                                |
| `conversation`            | UUID der übergeordneten Unterhaltung für Unteraufgaben                                                                       |
| `description`             | Aufgabenbeschreibung                                                                                                         |
| `due_at`                  | Unix-Zeitstempel dafür, wann die Aufgabe fällig ist                                                                          |
| `started_at`              | Unix-Zeitstempel dafür, wann die Arbeit begonnen hat                                                                         |
| `closed_at`               | Unix-Zeitstempel für den Zeitpunkt, an dem die Aufgabe als erledigt markiert wurde                                           |
| `zugewiesene Personen`\*  | Array von zugewiesenen Personen. UUIDs in List/Create/Update; vollständige Benutzerobjekte in Get a task und bei Kommentaren |
| `team`                    | Team. UUID in List/Create/Update; vollständiges Team-Objekt in Get a task und in comments                                    |
| `last_activity_at`        | Unix-Zeitstempel der letzten Aktivität. Nur enthalten in [Aufgaben auflisten](#list-tasks)                                   |

### Eine Aufgabe abrufen

`GET /v1/tasks/:id`

Rufen Sie eine einzelne Aufgabe anhand der ID ab. Gibt die Aufgabe mit allen Details zurück, einschließlich zugewiesener Personen und Team-Informationen.

{% code title="Vorlage" %}

```json
{
  "Aufgaben": {
    "id": "75ad834a-9bd6-4008-b9e6-fc9fa2e7770b",
    "conversation": null,
    "title": "Review pull request",
    "description": "Please review 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": "Entwicklung",
      "organization": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92"
    },
    "due_at": 1692371867,
    "type": "task"
  }
}
```

{% endcode %}

Die `zugewiesene Personen` Array enthält vollständige Benutzerobjekte mit `id`, `name`, `email`, und `avatar_url`. Das `team` Das Objekt enthält vollständige Team-Informationen mit `id`, `name`, und `Organisation`.

### Eine Aufgabe erstellen

`POST /v1/tasks`

Erstellen Sie eine neue Aufgabe. Aufgaben können eigenständig sein, Unterhaltungen sein oder innerhalb von Unterhaltungen erstellt werden.

{% hint style="info" %}
Über die API erstellte Aufgaben erscheinen im **Aufgaben** nur Ansicht, nicht der Posteingang. Das Erstellen einer Aufgabe bewirkt nicht, dass der Besitzer des API token der übergeordneten Unterhaltung automatisch folgt.

Wenn Sie Unteraufgaben innerhalb von Unterhaltungen erstellen, können Sie der übergeordneten Unterhaltung automatisch folgen. Um dies zu deaktivieren, gehen Sie zu **Einstellungen > Persönliche Einstellungen** und nach „watch“ suchen, um das zu finden und zu deaktivieren **automatisches Folgen bei der Aufgabenerstellung** Option.
{% endhint %}

{% tabs %}
{% tab title="Eigenständige Aufgabe" %}
{% code title="Anfrage-Payload" %}

```json
{
  "Aufgaben": {
    "Organisation": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92",
    "title": "Review pull request",
    "description": "Please review PR #123",
    "team": "0e24f298-965d-4475-9220-b32636a1e2c3",
    "due_at": 1692371867
  }
}
```

{% endcode %}
{% endtab %}

{% tab title="Unteraufgabe" %}
{% code title="Anfrage-Payload" %}

```json
{
  "Aufgaben": {
    "Organisation": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92",
    "title": "Follow up with client", 
    "description": "Details des Vorschlags besprechen",
    "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="Vorlage" %}

```json
{
  "Aufgaben": {
    "id": "75ad834a-9bd6-4008-b9e6-fc9fa2e7770b",
    "conversation": null,
    "title": "Aktualisierter Aufgabentitel",
    "description": "New description",
    "state": "in_progress",
    "assignees": ["1ce8117e-ae42-4304-b953-c81656da4bd1"],
    "team": "0e24f298-965d-4475-9220-b32636a1e2c3",
    "due_at": 1692371867
  }
}
```

{% endcode %}

**Parameter**

| Name (\* erforderlich)       | Beschreibung                                                                                                                         | Beispiel                                   |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------ |
| `title`\*                    | Aufgabentitel (max. 1000 Zeichen)                                                                                                    | `„Pull Request überprüfen“`                |
| `description`                | Aufgabenbeschreibung (max. 10.000 Zeichen)                                                                                           | `„Bitte PR #123 prüfen“`                   |
| `state`                      | Aufgabenstatus. Einer der folgenden: `todo`, `in_progress`, `Erledigt`                                                               | `"in_progress"`                            |
| `Organisation`               | Organisations-ID-Zeichenfolge (erforderlich bei Verwendung von team, assignees oder add\_users)                                      | `"0d9bab85-a74f-4ece-9142-0f9b9f36ff92"`   |
| `team`                       | Team-ID-Zeichenfolge (entweder Team oder zugewiesene Personen sind für eigenständige Aufgaben erforderlich)                          | `"0e24f298-965d-4475-9220-b32636a1e2c3"`   |
| `zugewiesene Personen`       | Array von Zeichenketten mit Benutzer-IDs (für eigenständige Aufgaben ist entweder Team oder zugewiesene Personen erforderlich)       | `["1ce8117e-ae42-4304-b953-c81656da4bd1"]` |
| `due_at`                     | Unix-Zeitstempel für das Fälligkeitsdatum der Aufgabe                                                                                | `1692371867`                               |
| `Unteraufgabe`               | Boolescher Wert, der angibt, ob dies eine Unteraufgabe einer Unterhaltung ist                                                        | `true`                                     |
| `conversation`               | Zeichenfolge für die ID der übergeordneten Unterhaltung (erforderlich, wenn Unteraufgabe wahr ist)                                   | `"a5d2aa1c-3828-4f90-bbd8-3dffaadda97e"`   |
| `references`                 | Array von Zeichenfolgen zum Finden oder Erstellen der übergeordneten Unterhaltung (wird beim Erstellen einer Unteraufgabe verwendet) | `["<some-reference-123>"]`                 |
| `conversation_subject`       | Betreff für die übergeordnete Unterhaltung beim Erstellen über Verweise                                                              | `„Neue Funktionsanfrage“`                  |
| `Nutzer hinzufügen`          | Array von Benutzer-IDs zum Hinzufügen zur übergeordneten Unterhaltung (nur für Unteraufgaben)                                        | `["74f91030-39b8-4627-9835-9cfbce9d67c1"]` |
| `Zum Posteingang hinzufügen` | Verschiebe die übergeordnete Unterhaltung für alle mit Zugriff in den Posteingang (nur für Unteraufgaben)                            | `true`                                     |

### Eine Aufgabe aktualisieren

`PATCH /v1/tasks/:id`

Aktualisiert die Attribute einer vorhandenen Aufgabe.

{% code title="Anfrage-Payload" %}

```json
{
  "Aufgaben": {
    "title": "Aktualisierter Aufgabentitel",
    "description": "New description",
    "state": "in_progress",
    "assignees": ["1ce8117e-ae42-4304-b953-c81656da4bd1"],
    "team": "0e24f298-965d-4475-9220-b32636a1e2c3",
    "due_at": 1692371867
  }
}
```

{% endcode %}

**Parameter**

| Name                   | Beschreibung                                                           | Beispiel                                   |
| ---------------------- | ---------------------------------------------------------------------- | ------------------------------------------ |
| `title`                | Aufgabentitel (max. 1000 Zeichen)                                      | `„Aktualisierter Aufgabentitel“`           |
| `description`          | Aufgabenbeschreibung (max. 10.000 Zeichen)                             | `„Neue Beschreibung“`                      |
| `state`                | Aufgabenstatus. Einer der folgenden: `todo`, `in_progress`, `Erledigt` | `"in_progress"`                            |
| `zugewiesene Personen` | Array von Benutzer-ID-Strings                                          | `["1ce8117e-ae42-4304-b953-c81656da4bd1"]` |
| `team`                 | Team-ID-Zeichenkette                                                   | `"0e24f298-965d-4475-9220-b32636a1e2c3"`   |
| `due_at`               | Unix-Zeitstempel für das Fälligkeitsdatum der Aufgabe                  | `1692371867`                               |

`title`

Der Titel der Aufgabe, der in der Aufgabenliste und in den Aufgabendetails angezeigt wird. Maximal 1.000 Zeichen.

`description`

Eine längere Beschreibung der Aufgabe, die zusätzlichen Kontext oder Details bietet. Die Beschreibung unterstützt Nur-Text und ist auf 10.000 Zeichen begrenzt.

`state`

Der aktuelle Status der Aufgabe. Kann einer der folgenden sein:

* `todo` - Aufgabe ist ausstehend und muss bearbeitet werden
* `in_progress` - Aufgabe wird derzeit bearbeitet
* `Erledigt` - Aufgabe wurde abgeschlossen oder erledigt

Wenn nicht angegeben, erhalten neue Aufgaben standardmäßig den `todo` Status.

`Organisation`

Die Organisations-ID ist erforderlich, wenn Sie Aufgaben Teams oder Nutzern über `team`, `zugewiesene Personen`, oder `Nutzer hinzufügen` Parameter zuweisen. Dadurch wird sichergestellt, dass die Aufgabe im richtigen Organisationskontext erstellt wird.

`team`

Für eigenständige Aufgaben (keine Unteraufgaben) muss entweder `team` oder `zugewiesene Personen` angegeben werden. Wenn ein Team zugewiesen wird, haben alle Teammitglieder Zugriff auf die Aufgabe und sie erscheint in der Aufgabenliste des Teams.

`zugewiesene Personen`

Für eigenständige Aufgaben (keine Unteraufgaben) muss entweder `team` oder `zugewiesene Personen` angegeben werden. Wenn Nutzern Aufgaben zugewiesen werden, sind sie für das Erledigen der Aufgabe verantwortlich und sie erscheinen in ihren persönlichen Aufgabenlisten.

`due_at`

Legt für die Aufgabe mithilfe eines Unix-Zeitstempels ein Fälligkeitsdatum fest. Die Aufgabe wird als überfällig markiert, wenn sie bis zu diesem Datum nicht erledigt ist. Das Festlegen dieses Felds ist optional.

`Unteraufgabe`

Wenn `true`, gibt an, dass diese Aufgabe als Unteraufgabe innerhalb einer Unterhaltung erstellt werden soll. Unteraufgaben benötigen entweder eine `conversation` ID oder `references` um die übergeordnete Unterhaltung zu identifizieren.

`conversation`

Erforderlich beim Erstellen einer Unteraufgabe (`subtask: true`). Gibt die ID der vorhandenen Unterhaltung an, in der die Unteraufgabe erstellt werden soll.

`references`

Eine Alternative zu `conversation` beim Erstellen von Unteraufgaben. Ermöglicht es Ihnen, die übergeordnete Unterhaltung anhand von Nachrichtenreferenzen (wie E-Mail-Message-IDs) zu finden oder zu erstellen. Wenn mehrere Unterhaltungen mit den Referenzen übereinstimmen, wird die Aufgabe in der ersten passenden Unterhaltung erstellt.

`conversation_subject`

Beim Erstellen einer Unteraufgabe mit `references` und eine neue Unterhaltung erstellt werden muss, legt dieses Feld den Betreff dieser neuen Unterhaltung fest.

`Nutzer hinzufügen`

Beim Erstellen von Unteraufgaben ermöglicht Ihnen dieser Parameter, der übergeordneten Unterhaltung weitere Nutzer hinzuzufügen. Diese Nutzer haben Zugriff sowohl auf die Unterhaltung als auch auf die Unteraufgabe. Der `Organisation` Parameter ist erforderlich, wenn Sie `Nutzer hinzufügen`.

`Zum Posteingang hinzufügen`

Beim Erstellen von Unteraufgaben übergeben Sie `add_to_inbox: true` um die übergeordnete Unterhaltung für alle mit Zugriff in den Posteingang zu verschieben. Ohne dies erscheint die Unterhaltung infolge der Aufgabenerstellung in niemandes Posteingang.

***

## Hooks

Beispielverwendung: Lösen Sie Workflows in externen Systemen automatisch aus, wenn neue Nachrichten eintreffen oder Kommentare hinzugefügt werden.

### Webhook erstellen

`POST /v1/hooks`

Erstellen Sie ein Webhook-Abonnement, um Benachrichtigungen für bestimmte Ereignisse in Missive zu erhalten. Dieser Endpoint ermöglicht Integrationen mit Diensten wie Zapier, n8n und anderen oder kann direkt für benutzerdefinierte Integrationen verwendet werden. Im Hintergrund erstellt dieser Endpoint eine Missive-Regel mit einer Webhook-Aktion - Sie können diese Regeln später in Ihren Missive-Einstellungen unter Regeln ansehen und bearbeiten, genauso wie jede andere Regel, die Sie manuell erstellen.

{% code title="Anfrage-Payload" %}

```json
{
  "hooks": {
    "type": "new_comment",
    "url": "https://hooks.example.com/callback",
    "Organisation": "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="Vorlage" %}

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

{% endcode %}

**Parameter**

| Name (\* erforderlich)    | Standard | Beschreibung                                                                                                                                                                                       |
| ------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` \*                 |          | Zu abonnierender Ereignistyp. Unterstützte Werte: incoming\_email, incoming\_sms\_message, incoming\_facebook\_message, incoming\_whatsapp\_message, incoming\_twilio\_chat\_message, new\_comment |
| `url` \*                  |          | Die Webhook-URL, die die Benachrichtigungen zu den Ereignissen empfängt                                                                                                                            |
| `Organisation`            | `null`   | Organisations-ID. Wenn nicht angegeben, wird ein persönliches Webhook-Abonnement erstellt                                                                                                          |
| `content_contains`        | `null`   | Nur auslösen, wenn der Inhalt diesen Text enthält                                                                                                                                                  |
| `content_starts_with`     | `null`   | Nur auslösen, wenn der Inhalt mit diesem Text beginnt                                                                                                                                              |
| `content_ends_with`       | `null`   | Nur auslösen, wenn der Inhalt mit diesem Text endet                                                                                                                                                |
| Nur für `new_comment`:    |          |                                                                                                                                                                                                    |
| `is_task`                 | `false`  | Nur bei Kommentaren zu Aufgaben auslösen                                                                                                                                                           |
| `author`                  | `null`   | Nur bei Kommentaren dieser Nutzer-ID auslösen                                                                                                                                                      |
| `mention`                 | `null`   | Nur auslösen, wenn diese Nutzer-ID erwähnt wird                                                                                                                                                    |
| Nur für `incoming_email`: |          |                                                                                                                                                                                                    |
| `from_eq`                 | `null`   | Nur für Nachrichten von genau dieser E-Mail-Adresse auslösen                                                                                                                                       |
| `subject_contains`        | `null`   | Nur für Nachrichten mit diesem Text im Betreff auslösen                                                                                                                                            |

### Webhook löschen

`DELETE /v1/hooks/:id`

Löschen Sie ein Webhook-Abonnement. Im Hintergrund wird die Regel gelöscht, die die Webhook-Aktion enthält.

Zuletzt aktualisiert am 18. September 2025

***

Benötigen Sie genauere Antworten?\\\\


---

# 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/de/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.
