CRMCRM-Unternehmen

CRM-Unternehmen

Veraltete CRM-Unternehmens-API für Listen, Erstellung, Änderungen und Löschung, mit Hinweis auf die Ablösung durch CRM-Gruppen.

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
}

Die CRM-Unternehmens-API ist veraltet. Unternehmen werden durch CRM-Gruppen ersetzt. Verwenden Sie für neue Integrationen die CRM-Gruppen-API.

Veraltete 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 sind veraltet und 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

MethodePfadZweckStatus
GET/api/crm/companiesUnternehmen auflistenVeraltet
POST/api/crm/companiesUnternehmen erstellenVeraltet; gibt 410 Gone zurück
GET/api/crm/companies/{id}Einzelnes Unternehmen abrufenVeraltet
PATCH/api/crm/companies/{id}Unternehmen aktualisierenVeraltet
DELETE/api/crm/companies/{id}Unternehmen löschenVeraltet
GET/api/crm/companies/{id}/contactsKontakte eines Unternehmens auflistenVeraltet
POST/api/crm/companies/{id}/contactsKontakt zu einem Unternehmen hinzufügenVeraltet
DELETE/api/crm/companies/{id}/contactsKontakt von einem Unternehmen entfernenVeraltet

Unternehmen auflisten

Rufen Sie GET /api/crm/companies auf, um Unternehmensdatensätze seitenweise abzurufen oder mit einer Suchanfrage zu filtern.

GET /api/crm/companies ist veraltet, bleibt aber weiterhin funktionsfähig. Verwenden Sie für neue Integrationen die Gruppenendpunkte.

Query-Parameter

query
teamIdstring
Required

ID des Teams, dessen Unternehmen abgerufen werden.

query
pageinteger

Die Seitennummer der Ergebnisliste.

query
limitinteger

Die maximale Anzahl der zurückgegebenen Unternehmen pro Seite.

Antwortfelder

successboolean
Required

Gibt an, ob die Anfrage erfolgreich war.

companiesarray
Required

Liste der gefundenen Unternehmensdatensätze.

companies[].idstring
Required

Eindeutige ID des Unternehmens.

companies[].namestring
Required

Name des Unternehmens.

companies[].websitestring

Webadresse des Unternehmens, falls hinterlegt.

companies[].industrystring

Branche des Unternehmens, falls hinterlegt.

totalinteger
Required

Gesamtzahl der Treffer über alle Seiten hinweg.

pageinteger
Required

Die aktuelle Ergebnisseite.

Unternehmen erstellen

POST /api/crm/companies ist veraltet und gibt HTTP 410 Gone zurück. Der Endpunkt erstellt keine neuen Unternehmensdatensätze mehr.

Verweisen Sie Clients auf POST /api/crm/groups, um neue CRM-Gruppen anzulegen. Verwenden Sie die CRM-Gruppen-Referenz für Request- und Antwortfelder.

Einzelnes Unternehmen abrufen

Rufen Sie GET /api/crm/companies/{id} auf, um einen einzelnen Unternehmensdatensatz anhand seiner ID abzurufen.

Pfadparameter

path
idstring
Required

Eindeutige ID des Unternehmens.

Antwortstruktur

successboolean
Required

Gibt an, ob die Anfrage erfolgreich war.

companyobject
Required

Der angeforderte Unternehmensdatensatz.

company.idstring
Required

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

path
idstring
Required

Eindeutige ID des zu aktualisierenden Unternehmens.

Aktualisierbare Felder

body
namestring

Aktualisierter Unternehmensname.

body
websitestring

Aktualisierte Webadresse.

body
industrystring

Aktualisierte Branchenangabe.

body
phonestring

Aktualisierte Telefonnummer.

body
addressstring

Aktualisierte Geschäftsadresse.

Antwortstruktur

successboolean
Required

Gibt an, ob die Aktualisierung erfolgreich war.

companyobject
Required

Der aktualisierte Unternehmensdatensatz.

Unternehmen löschen

Senden Sie DELETE /api/crm/companies/{id}, um einen Unternehmensdatensatz aus dem CRM zu entfernen.

Pfadparameter

path
idstring
Required

Eindeutige ID des zu löschenden Unternehmens.

Antwortstruktur

successboolean
Required

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

path
idstring
Required

Eindeutige ID des Unternehmens.

Antwortfelder

successboolean
Required

Gibt an, ob die Anfrage erfolgreich war.

contactsarray
Required

Liste der dem Unternehmen zugeordneten Kontakte.

Verwandte Ressourcen