CRM-Unternehmen
Unternehmen im Talkturo-CRM erstellen, auflisten, aktualisieren und löschen — Organisationsdatensätze mit benutzerdefinierten Feldern und Kontaktzuordnungen verwalten.
curl -X GET "https://api.talkturo.local/api/crm/companies?page=1&limit=20&search=Acme" \
-H "Cookie: sb-session=example_session_token"
{
"success": true,
"companies": [
{
"id": "cmp_9f2c7a1d",
"name": "Acme Industrial Group",
"website": "https://acme-industrial.com",
"industry": "Manufacturing"
},
{
"id": "cmp_2b7d1e4a",
"name": "Acme Logistics GmbH",
"website": "https://acme-logistics.de",
"industry": "Logistics"
}
],
"total": 42,
"page": 1
}
curl -X POST "https://api.talkturo.local/api/crm/companies" \
-H "Content-Type: application/json" \
-H "Cookie: sb-session=example_session_token" \
-d '{
"name": "Northwind Health Partners",
"website": "https://northwind-health.com",
"industry": "Healthcare",
"phone": "+49 30 55550123",
"address": "Friedrichstraße 120, 10117 Berlin"
}'
{
"success": true,
"company": {
"id": "cmp_c4a91e7b",
"name": "Northwind Health Partners",
"website": "https://northwind-health.com",
"industry": "Healthcare",
"phone": "+49 30 55550123",
"address": "Friedrichstraße 120, 10117 Berlin"
}
}
Unternehmen im CRM verwalten
Unternehmensendpunkte verwalten Organisationsdatensätze im Talkturo-CRM. Sie können Unternehmen auflisten, neue Datensätze anlegen, einzelne Unternehmen abrufen, bestehende Einträge aktualisieren, löschen und die zugeordneten Kontakte eines Unternehmens abfragen.
Alle Endpunkte in diesem Abschnitt verwenden Session-Authentifizierung. Senden Sie die Anfragen aus einer angemeldeten Anwendungssitzung.
Die Listenansicht unterstützt Seitennummerierung und Suche. Die Detailendpunkte arbeiten mit der Unternehmens-ID aus dem CRM.
Endpunktübersicht
| Methode | Pfad | Zweck |
|---|---|---|
GET | /api/crm/companies | Unternehmen auflisten |
POST | /api/crm/companies | Unternehmen erstellen |
GET | /api/crm/companies/{id} | Einzelnes Unternehmen abrufen |
PATCH | /api/crm/companies/{id} | Unternehmen aktualisieren |
DELETE | /api/crm/companies/{id} | Unternehmen löschen |
GET | /api/crm/companies/{id}/contacts | Kontakte eines Unternehmens auflisten |
Unternehmen auflisten
Rufen Sie GET /api/crm/companies auf, um Unternehmensdatensätze seitenweise abzurufen oder mit einer Suchanfrage zu filtern.
Query-Parameter
Die Seitennummer der Ergebnisliste.
Die maximale Anzahl der zurückgegebenen Unternehmen pro Seite.
Filtert die Liste nach einem Suchbegriff.
Antwortfelder
Gibt an, ob die Anfrage erfolgreich war.
Liste der gefundenen Unternehmensdatensätze.
Eindeutige ID des Unternehmens.
Name des Unternehmens.
Webadresse des Unternehmens, falls hinterlegt.
Branche des Unternehmens, falls hinterlegt.
Gesamtzahl der Treffer über alle Seiten hinweg.
Die aktuelle Ergebnisseite.
Unternehmen erstellen
Senden Sie POST /api/crm/companies, um einen neuen Unternehmensdatensatz im CRM anzulegen.
Request-Body
Name des Unternehmens.
Webadresse des Unternehmens.
Branche oder Marktsegment des Unternehmens.
Telefonnummer des Unternehmens.
Postanschrift oder Geschäftsadresse des Unternehmens.
Antwortfelder
Gibt an, ob das Unternehmen erfolgreich erstellt wurde.
Der neu angelegte Unternehmensdatensatz.
Eindeutige ID des neuen Unternehmens.
Wenn Sie Unternehmensdatensätze später mit Kontakten oder Opportunities verknüpfen möchten, speichern Sie die zurückgegebene company.id direkt nach dem Erstellen.
Einzelnes Unternehmen abrufen
Rufen Sie GET /api/crm/companies/{id} auf, um einen einzelnen Unternehmensdatensatz anhand seiner ID abzurufen.
Pfadparameter
Eindeutige ID des Unternehmens.
Antwortstruktur
Gibt an, ob die Anfrage erfolgreich war.
Der angeforderte Unternehmensdatensatz.
Eindeutige ID des Unternehmens.
Unternehmen aktualisieren
Senden Sie PATCH /api/crm/companies/{id}, um vorhandene Felder eines Unternehmens zu ändern. Der Endpunkt gibt den aktualisierten Datensatz zurück.
Pfadparameter
Eindeutige ID des zu aktualisierenden Unternehmens.
Aktualisierbare Felder
Aktualisierter Unternehmensname.
Aktualisierte Webadresse.
Aktualisierte Branchenangabe.
Aktualisierte Telefonnummer.
Aktualisierte Geschäftsadresse.
Antwortstruktur
Gibt an, ob die Aktualisierung erfolgreich war.
Der aktualisierte Unternehmensdatensatz.
Unternehmen löschen
Senden Sie DELETE /api/crm/companies/{id}, um einen Unternehmensdatensatz aus dem CRM zu entfernen.
Pfadparameter
Eindeutige ID des zu löschenden Unternehmens.
Antwortstruktur
Gibt an, ob der Datensatz erfolgreich gelöscht wurde.
Das Löschen eines Unternehmens ist als Operation destruktiv. Prüfen Sie vor dem Entfernen, ob nachgelagerte Prozesse oder verknüpfte Datensätze die Unternehmens-ID noch verwenden.
Kontakte eines Unternehmens auflisten
Rufen Sie GET /api/crm/companies/{id}/contacts auf, um alle Kontakte abzurufen, die einem Unternehmen zugeordnet sind.
Pfadparameter
Eindeutige ID des Unternehmens.
Antwortfelder
Gibt an, ob die Anfrage erfolgreich war.
Liste der dem Unternehmen zugeordneten Kontakte.