5.1.7.1.1. Methode: POST

Syntax: POST /api/v1/lead

Über diese Schnittstelle können schnell und einfach von extern Leads angelegt werden. Dabei werden eine Firma, ein Kontakt und eine Verkaufschance erstellt. Wenn ein bestehender Datensatz gefunden wird, wird dieser verwendet. Bestehende Datensätze werden nicht aktualisiert oder mit Informationen angereichert.

Für diese Schnittstelle wird ein ausführliches Webservice-Protokoll geschrieben.

Erkennen von bestehenden Datensätzen

Nur für Firma und Kontakt wird geprüft, ob es bereits bestehende Datensätze gibt. Verkaufschancen hingegen werden immer neu angelegt. Beim Erkennen von bestehenden Datensätzen wird auch die Relationshierarchie berücksichtigt. Bei neuen Datensätzen werden entsprechende Relationen erstellt. Eine Zuordnung durch ein Kriterium muss eindeutig sein. Andernfalls wird sie ignoriert. Die Reihenfolge der Kriterien ist relevant. Sobald entweder eine Firma oder ein Kontakt gefunden wurde, wird kein weiteres Kriterium geprüft.

Es gibt folgende Kriterien zum Erkennen von bestehenden Datensätzen:

• Migrations Id (Id)
  • Wenn ein Kontakt gefunden wird, wird auch die übergeordnete Firma erkannt
  • Wenn eine Firma gefunden wird, kann ein Kontakt über die E-Mail-Adresse ermittelt werden
• Kundennummer (Number)
  • Eine Firma kann über deren Kundennummer ermittelt werden
  • Wenn eine Firma gefunden wird, kann ein Kontakt über die E-Mail-Adresse ermittelt werden
• E-Mail-Adresse (EMailAddress)
  • Ein Kontakt kann über seine E-Mail-Adresse zugeordnet werden
  • Wenn ein Kontakt gefunden wird, wird auch die übergeordnete Firma erkannt
  • Wenn kein Kontakt gefunden wird, wird eine Firma mit der E-Mail-Adresse gesucht
• Domainsuche für E-Mail-Adresse (EMailAddress)
  • Der Domainteil von einer E-Mail-Adresser (user@domain.de) wird für die Suche verwendet
  • Es wird nur die E-Mail-Adresse von der Firma geprüft
  • Für “max.mustermann@gedys.com” wird eine Firma mit “info@gedys.com” erkannt

Datentypen, welche verarbeitet werden

Gewisse Felder entscheiden, ob ein Datentyp von der Schnittstelle verarbeitet wird:

• Kontakte werden nur verarbeitet, wenn “LastName” (Nachname) gegeben ist.
• Firmen werden nur verarbeitet, wenn “Company” (Firmenname) gegeben ist.
• Verkaufschancen werden nur verarbeitet, wenn “Subject” (Betreff) gegeben ist.
  

Ausgeschlossene E-Mail-Adressen für bestehende Kontakte

Für gewisse E-Mail-Adressen wird die Suche nach bestehenden Kontakten ausgeschlossen:

• info@
• mail@
• kontakt@
• webmaster@
• noreply@
• support@
• service@
• marketing@
• kundenservice@
• post@
• poststelle@
• rechnung@
• rechnung-service@
• service-shop@
• servicedesk@
  

Parameter (URL)

Parameter (Body)

Mögliche Rückgabestatus

Rückgabe

Der Aufruf dieses Endpunkts liefert eine JSON-Struktur mit Informationen über diesen Prozess aus.

Beispiel:

[
    {
        "Opportunity": {
          "Action": "Created/Existing",
          "Oid": "00000000-0000-0000-0000-000000000000"
        },
        "Contact": { ... },
        "Company": { ... },
    }
]