---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# E-Mail-API

# E-Mail-API {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 25. Juni 2026
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 5 Minuten Lesedauer

Die E-Mail Die API stellt Endpunkte bereit, mit denen Sie E-Mail-Nachrichten mit REST empfangen und senden können. {#email-api__release-notes-feature-description}
Anwender müssen über die Rolle „email_api_send" verfügen, um E-Mails zu senden.  
Hinweis:  
Sie können Fehler erhalten, wenn Sie keinen Lese-/Schreibzugriff auf die E-Mail-Tabelle \[sys_email\] haben.

## E-Mail -- RUFT /now/email/{ID} AB {#ariaid-title2}

Gibt die E-Mail-Details für den angegebenen E-Mail-Datensatz zurück.

### URL-Format {#email-GET__section_kdx_pzs_cmb}

Versionierte URL: /api/now/{api_Version}/email/{ID}  
Hinweis:  
Verfügbare Versionen werden in angegeben [REST-API-Explorer](https://servicenow-prod.fluidtopics.net/QZyr9s_~V0xB9fqGOlvJ4A "In diesem Tutorial verwenden Sie den REST API Explorer, um zu testen ServiceNowREST-APIs."). Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf [Geskriptetes REST-Service-Formular](https://servicenow-prod.fluidtopics.net/0V9QfkPsOI5r~YAD7CJWCA "Mit der geskripteten REST-API-Funktion können Anwendungsentwickler anwenderdefinierte Webservice-APIs erstellen.").

### Unterstützte Anforderungsparameter

{#email-GET__entry__2}{#email-GET__version-not_optional-RESTAPI}

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: <kbd class="ph userinput">v1 </kbd>Oder <kbd class="ph userinput">v2 </kbd>. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| ID | SYS_ID der E-Mail, für die Details zurückgegeben werden sollen. Datentyp: Zeichenfolge Tabelle: E-Mail \[sys_email\] |
[Tabelle : 1. Pfad-Parameter]

{#email-GET__entry__8}

| Name | Beschreibung |
|-|-|
| Sysparm_fields | Kommagetrennte Liste von Feldern, die in der Antwort zurückgegeben werden sollen. Datentyp: Zeichenfolge |
[Tabelle : 2. Abfrageparameter]

{#email-GET__entry__12}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 3. Anforderungstext-Parameter (XML oder JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#email-GET__entry__16}{#email-GET__accept-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json |
[Tabelle : 4. Anforderungskopfzeilen.]

{#email-GET__entry__20}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 5. Antwort-Header]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#email-GET__entry__24}{#email-GET__entry-200-status-code}{#email-GET__entry-401-status-code}{#email-GET__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 403 | Gibt an, dass der Datensatz nicht gefunden wurde oder der anfordernde Anwender keinen Zugriff auf den Datensatz hat. Stellen Sie sicher, dass der Anwender über die richtige Rolle und Zugriffsberechtigungen verfügt. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
[Tabelle : 6. Statuscodes]

### Antworttext-Parameter (JSON oder XML)

{#email-GET__entry__34}

| Element | Beschreibung |
|-|-|
| Bcc | Liste der E-Mail-Adressen der blinden kopierten Empfänger der E-Mail-Nachricht. Ordnet das Feld „blind_copy" zu. Datentyp: Array |
| Cc | Liste der E-Mail-Adressen der kopierten Empfänger für die E-Mail-Nachricht. Ordnet dem kopierten Feld zu. Datentyp: Array |
| headers | Name-Wert-Paare der Header, die der Nachricht und ihren Werten zugeordnet sind. Datentyp: Objekt |
| html | HTML-fähiger Textkörper der E-Mail-Nachricht. Ordnet dem Textfeld zu. Datentyp: Zeichenfolge |
| ID | SYS_ID des E-Mail-Datensatzes. Datentyp: Zeichenfolge |
| importance | Wichtigkeit der E-Mail-Nachricht. Ordnet dem Feld „Wichtigkeit" zu. Datentyp: Zeichenfolge |
| Staat | Verarbeitungsstatus der E-Mail-Nachricht. Gibt an, ob die geplanten Systemaufgaben die E-Mail-Nachricht verarbeitet haben. Mögliche umfassen: * Fehler * ignored * Verarbeitet * Bereit {#email-GET__ul_l1x_dp2_zw} Datentyp: Zeichenfolge |
| subject | Betreff der E-Mail-Nachricht. Ordnet dem Betrefffeld zu. Datentyp: Zeichenfolge |
| HTML | Nur-Textkörper der E-Mail-Nachricht. Ordnet dem Feld „body_Text" zu. Datentyp: Zeichenfolge |
| bis | Liste der E-Mail-Adressen der direkten Empfänger der E-Mail-Nachricht. Ordnet dem Empfängerfeld zu. Datentyp: Array |
| Typ | Aktueller Status der E-Mail-Nachricht als eingehende oder ausgehende E-Mail. Mögliche Werte: * empfangen * erhalten (ignoriert) * senden (fehlgeschlagen) * senden (ignoriert) * sendebereit * gesendet {#email-GET__ul_z3k_n42_zw} Datentyp: Zeichenfolge |
[ ]

### Beispiel für Curl-Anforderung

    curl "http://instance.servicenow.com/api/now/email/06e095427f0022007f005212bdfa91b3" \
    --request GET \
    --header "Accept:application/json" \
    --user "user-name":"password"

    {
      "result" : {
        "headers" : {
          "X-ServiceNow-SysEmail-Version" : "2",
          "X-ServiceNow-Source" : "Notification-24e34b54c61122aa0108c1b7a33697cf"
        },
        "cc" : [
          ""
        ],
        "type" : "send-ready",
        "html" : "<html><head></head><body><div><p><font size=\"5\" color=\"#808080\" face=\"helvetica\"><strong>Incident has been closed.</strong></font></p></div>\n\t\t<div><p><font size=\"4\" color=\"#808080\" face=\"helvetica\"><strong>Summary details</strong></font></p><p><font size=\"3\" color=\"#808080\" face=\"helvetica\">Closed by: System Administrator</font></p><p><font size=\"3\" color=\"#808080\" face=\"helvetica\">Closed notes: Fixed</font></p></div>\n\t\t<div><p><font size=\"3\" color=\"#808080\" face=\"helvetica\">You can view all the details of the incident by following the link below:</font></p><font face=\"helvetica\"><a href=\"incident.do?sys_id=e8e875b0c0a80164009dc852b4d677d5&amp;sysparm_stack=incident_list.do?sysparm_query=active=true\" style=\"background-color: #278efc;border: 1px solid #0368d4;color: #ffffff;font-size: 16px;font-family: Helvetica, Arial, sans-serif;text-decoration: none; border-radius: 3px;-webkit-border-radius: 3px;-moz-border-radius: 3px;display: inline-block;padding: 5px;\">Take me to the Incident</a></font><br /><br /><p><font size=\"3\" color=\"#808080\" face=\"helvetica\">Thank you.</font></p></div><div> </div><div style=\"display:inline\">Ref:MSG0000006</div></body></html>",
        "bcc" : [
          ""
        ],
        "subject" : "Your incident INC0000005 has been closed",
        "to" : [
          "alejandro.mascall@example.com"
        ],
        "state" : "ready",
        "id" : "06e095427f0022007f005212bdfa91b3",
        "importance" : "",
        "text" : ""
      }
    }

## E-Mail: VERÖFFENTLICHEN SIE /now/email {#ariaid-title3}

Erstellt einen E-Mail-Datensatz anhand der übergebenen Informationen.

### URL-Format {#email-POST__section_urw_jpt_cmb}

Versionierte URL: /api/now/{api_Version}/email  
Hinweis:  
Verfügbare Versionen werden in angegeben [REST-API-Explorer](https://servicenow-prod.fluidtopics.net/QZyr9s_~V0xB9fqGOlvJ4A "In diesem Tutorial verwenden Sie den REST API Explorer, um zu testen ServiceNowREST-APIs."). Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf [Geskriptetes REST-Service-Formular](https://servicenow-prod.fluidtopics.net/0V9QfkPsOI5r~YAD7CJWCA "Mit der geskripteten REST-API-Funktion können Anwendungsentwickler anwenderdefinierte Webservice-APIs erstellen.").

### Unterstützte Anforderungsparameter

{#email-POST__entry__2}{#email-POST__version-not_optional-RESTAPI}

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: <kbd class="ph userinput">v1 </kbd>Oder <kbd class="ph userinput">v2 </kbd>. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
[Tabelle : 7. Pfad-Parameter]

{#email-POST__entry__6}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 8. Abfrageparameter]

{#email-POST__entry__10}

| Element | Beschreibung |
|-|-|
| Bcc | Liste der E-Mail-Adressen der blinden kopierten Empfänger der E-Mail-Nachricht. Ordnet das Feld „blind_copy" zu. Hinweis: Sie können in diesem Feld nur bis zu 100 Adressen angeben. Datentyp: Array |
| Cc | Liste der E-Mail-Adressen der kopierten Empfänger für die E-Mail-Nachricht. Ordnet dem kopierten Feld zu. Hinweis: Sie können in diesem Feld nur bis zu 100 Adressen angeben. Datentyp: Array |
| headers | Name-Wert-Paare der Header, die der Nachricht und ihren Werten zugeordnet sind. Datentyp: Objekt |
| html | HTML-fähiger Textkörper der E-Mail-Nachricht. Ordnet dem Textfeld zu. Datentyp: Zeichenfolge |
| importance | Wichtigkeit der E-Mail-Nachricht. Ordnet dem Feld „Wichtigkeit" zu. Datentyp: Zeichenfolge |
| subject | Betreff der E-Mail-Nachricht. Ordnet dem Betrefffeld zu. Datentyp: Zeichenfolge |
| table_name | Name der Tabelle zum Speichern der E-Mail. Verwenden Sie diesen Parameter, um eine E-Mail-Nachricht einem bestimmten zugehörigen Datensatz an anderer Stelle im System zuzuordnen. Hinweis: Für diesen Parameter muss auch angegeben werden table_record_idParameter. Datentyp: Zeichenfolge |
| Table_Record_ID | Zielbezogener Datensatz, für den die E-Mail gilt. Verwenden Sie diesen Parameter, um eine E-Mail-Nachricht einem bestimmten zugehörigen Datensatz an anderer Stelle im System zuzuordnen. Hinweis: Für diesen Parameter muss auch angegeben werden table_nameParameter. Datentyp: Zeichenfolge |
| HTML | Nur-Textkörper der E-Mail-Nachricht. Ordnet dem Feld „body_Text" zu. Datentyp: Zeichenfolge |
| bis | Erforderlich. Liste der E-Mail-Adressen der direkten Empfänger für die E-Mail-Nachricht. Ordnet dem Empfängerfeld zu. Hinweis: Sie können in diesem Feld nur bis zu 100 Adressen angeben. Datentyp: Array |
[Tabelle : 9. Anforderungstext-Parameter (XML oder JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#email-POST__entry__32}{#email-POST__accept-RESTAPI}{#email-POST__content_type-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json |
| Inhaltstyp | Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json |
[Tabelle : 10. Anforderungskopfzeilen.]

{#email-POST__entry__38}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 11. Antwort-Header]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#email-POST__entry__42}{#email-POST__entry-200-status-code}{#email-POST__entry-400-status-code}{#email-POST__entry-401-status-code}{#email-POST__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 403 | Anfordernder Anwender hat keinen Zugriff auf den Datensatz. Stellen Sie sicher, dass der Anwender über die richtige Rolle und Zugriffsberechtigungen verfügt. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
[Tabelle : 12. Statuscodes]

### Antworttext-Parameter (JSON oder XML)

{#email-POST__entry__54}

| Element | Beschreibung |
|-|-|
| href | Link zum E-Mail-Datensatz als E-Mail-API-GET-Anforderung. Datentyp: Zeichenfolge |
| ID | SYS_ID des E-Mail-Datensatzes. Datentyp: Zeichenfolge |
| Links | Liste der Links zum E-Mail-Datensatz. Datentyp: Array |
| rel | Typ des Links, der in aufgeführt ist hrefParameter. Mögliche Werte: * Selbst: Die E-Mail-API RUFT die Anforderung für den E-Mail-Datensatz AB. * Status: Die E-Mail-API RUFT die Anforderung für den E-Mail-Datensatz ab, die nur die Felder „ID", „Typ", „Status" und „Fehler" anzeigt. {#email-POST__ul_gwp_rrt_cmb} Datentyp: Zeichenfolge |
[ ]

### Beispiel für Curl-Anforderung

    curl "http://instance.servicenow.com/api/now/email" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --user 'username':'password'\
    --data "{
      \"to\": [
        \"User1 <user1@example.com>\",
        \"User2 <user2@example.com>\"
      ],
      \"cc\": [
        \"User3 <user3@example.com>\",
        \"User4 <user4@example.com>\"
      ],
      \"bcc\": [
        \"User5 <user5@example.com>\",
        \"User6 <user6@example.com>\"
      ],
      \"subject\": \"Hello There\",
      \"text\": \"Test Message\",
      \"html\": \"<b>Test Message</b>\",
      \"table_name\": \"incident\",
      \"table_record_id\": \"136b2140bd0312004d7d1371f1abbdb6\",
      \"headers\": {
        \"X-Custom\": \"header\"
      }
    }"

    {
     "result": {
       "id": "b963219a44b02200964f63773cd6adfc",
       "links": [
         {
           "rel": "self",
           "href": "/now/v1/email/b963219a44b02200964f63773cd6adfc"
         },
         {
           "rel": "status",
           "href": "/now/v1/email/b963219a44b02200964f63773cd6adfc?sysparm_fields=id,type,state,error"
         }
       ]
     }
    }


