Zum Hauptinhalt springen
POST
Kontakt erstellen
Sende fullName und die weiteren Angaben, die du speichern möchtest. Der Name darf nicht leer sein. Alle anderen Felder sind optional.

Anhand der E-Mail-Adresse erstellen oder aktualisieren

Wenn die E-Mail-Adresse zu einem gespeicherten Kontakt in diesem Workspace passt, aktualisiert Tapify dessen Daten mit den gesendeten Feldern. Groß- und Kleinschreibung spielen beim Vergleich keine Rolle. Nicht gesendete Felder behalten ihren bisherigen Wert. Ohne E-Mail-Adresse erstellt jede Anfrage einen neuen Kontakt. Wenn du die ID eines bestehenden Kontakts kennst, verwende Kontakt aktualisieren.

Teammitglied zuweisen

Setze connectedWithProfileId auf eine id aus Teammitglieder auflisten. Das Mitglied muss zum selben Workspace gehören. Beim Erstellen oder Zuweisen eines Kontakts wird keine E-Mail an diese Person gesendet.

Notizen und Tags

Verwende internalNote für eine interne Notiz im Workspace. message enthält die von der Person übermittelte Nachricht, captureMethod die Erfassungsmethode. Beide Felder sind schreibgeschützt. Wenn du sie mitsendest, erhältst du 400 Bad Request. Neue API-Kontakte verwenden captureMethod: "manual".
Wenn du tags sendest, ersetzt du die vollständige Tag-Liste. Das gilt auch, wenn ein bestehender Kontakt anhand der E-Mail-Adresse aktualisiert wird. Mit [] entfernst du alle Tags.Tags gelten für den gesamten Workspace. Verwendest du einen bestehenden Namen erneut, wird die Farbe überall aktualisiert. Ohne Farbangabe wird neutral verwendet.

Autorisierungen

Authorization
string
header
erforderlich

Unter Einstellungen → API-Schlüssel erstellter API-Schlüssel.

Body

application/json

Erstelle einen Kontakt oder aktualisiere einen gespeicherten Kontakt in diesem Workspace, der anhand der E-Mail-Adresse zugeordnet wird. Ausgelassene Felder bleiben bei einem zugeordneten Kontakt unverändert. message und captureMethod sind schreibgeschützt und dürfen nicht übergeben werden.

fullName
string
erforderlich

Vollständiger Name mit mindestens einem Zeichen, das kein Leerraumzeichen ist.

Minimum string length: 1
Beispiel:

"Alex Morgan"

jobTitle
string | null
Beispiel:

"Sales Director"

company
string | null
Beispiel:

"Northstar"

email
string<email> | null

E-Mail-Adresse für die Kontaktsuche in diesem Workspace, bei der die Groß- und Kleinschreibung nicht berücksichtigt wird.

Beispiel:

"alex@northstar.example"

mobile
string | null

Mobiltelefonnummer.

Beispiel:

"+31612345678"

phone
string | null

Andere Telefonnummer, zum Beispiel eine Büronummer.

website
string | null
Beispiel:

"https://northstar.example"

linkedin
string | null
Beispiel:

"https://linkedin.com/in/alex-morgan"

address
string | null
Beispiel:

"Amsterdam, Netherlands"

internalNote
string | null

Private Workspace-Notiz. Tapify zeigt sie dem Kontakt nicht an und sendet sie ihm nicht.

Beispiel:

"Added from our CRM."

connectedWithProfileId
string<uuid> | null

Mitglieder-ID aus dem Endpunkt team-members in diesem Workspace. Verwende null, um die Zuweisung aufzuheben. Sendet keine E-Mail.

Beispiel:

"45fa16aa-2546-49b3-9d1e-7b7e1c9fb1e7"

tags
object[]

Vollständige Ersatzliste der Tags. Gib alle Tags an, die erhalten bleiben sollen, oder sende [], um alle zu entfernen. Gilt auch für Kontakte, die anhand der E-Mail-Adresse zugeordnet werden. Tag-Farben gelten für den gesamten Workspace.

Antwort

Vorhandener Kontakt aktualisiert

data
object
erforderlich

Ein im Tapify-Teams-Workspace gespeicherter Kontakt.