CRM-Benutzerdefinierte Felder
Benutzerdefinierte Felder für Kontakte, Unternehmen und Opportunities im Talkturo-CRM erstellen, auflisten, aktualisieren und löschen — Datensätze mit Text-, Zahlen-, Datums-, Auswahl- und Boolean-Feldtypen erweitern.
curl -X GET "https://api.talkturo.com/api/crm/custom-fields" \
-H "Cookie: sb-access-token=example_session_token_9xmk7q2r"
{
"success": true,
"fields": [
{
"id": "cf_8d3a2f91",
"name": "Industry Segment",
"type": "select",
"entity_type": "company"
},
{
"id": "cf_3b7c4e20",
"name": "Renewal Date",
"type": "date",
"entity_type": "opportunity"
}
]
}
curl -X POST "https://api.talkturo.com/api/crm/custom-fields" \
-H "Content-Type: application/json" \
-H "Cookie: sb-access-token=example_session_token_9xmk7q2r" \
-d '{
"name": "Lead Source",
"type": "select",
"entity_type": "contact",
"options": ["Referral", "Website", "Partner"]
}'
{
"success": true,
"field": {
"id": "cf_b5f29410",
"name": "Lead Source",
"type": "select",
"entity_type": "contact",
"options": ["Referral", "Website", "Partner"]
}
}
curl -X GET "https://api.talkturo.com/api/crm/custom-fields/cf_b5f29410" \
-H "Cookie: sb-access-token=example_session_token_9xmk7q2r"
{
"success": true,
"field": {
"id": "cf_b5f29410",
"name": "Lead Source",
"type": "select",
"entity_type": "contact",
"options": ["Referral", "Website", "Partner"]
}
}
curl -X PATCH "https://api.talkturo.com/api/crm/custom-fields/cf_b5f29410" \
-H "Content-Type: application/json" \
-H "Cookie: sb-access-token=example_session_token_9xmk7q2r" \
-d '{
"name": "Primary Lead Source",
"options": ["Referral", "Website", "Partner", "Event"]
}'
{
"success": true,
"field": {
"id": "cf_b5f29410",
"name": "Primary Lead Source",
"type": "select",
"entity_type": "contact",
"options": ["Referral", "Website", "Partner", "Event"]
}
}
curl -X DELETE "https://api.talkturo.com/api/crm/custom-fields/cf_b5f29410" \
-H "Cookie: sb-access-token=example_session_token_9xmk7q2r"
{
"success": true
}
CRM-Datensätze mit benutzerdefinierten Feldern erweitern
Benutzerdefinierte Felder ergänzen Kontakte, Unternehmen und Opportunities um eigene Datenpunkte, die in Ihrem CRM-Workflow fehlen. Über diese Endpunkte listen Sie vorhandene Felder auf, legen neue Felder an, rufen einzelne Felder ab, aktualisieren deren Namen oder Auswahloptionen und löschen nicht mehr benötigte Felder.
Alle Endpunkte in diesem Bereich verwenden Session-Authentifizierung. Die Antworten folgen durchgängig dem Muster success: true und liefern je nach Operation entweder fields, field oder nur eine Erfolgsbestätigung zurück.
Benutzerdefinierte Felder unterstützen die Feldtypen text, number, date, select und boolean. Das Feld options verwenden Sie nur für den Typ select.
Endpunkte im Überblick
| Methode | Pfad | Zweck |
|---|---|---|
GET | /api/crm/custom-fields | Alle benutzerdefinierten Felder auflisten |
POST | /api/crm/custom-fields | Ein neues benutzerdefiniertes Feld erstellen |
GET | /api/crm/custom-fields/[id] | Ein benutzerdefiniertes Feld anhand seiner ID abrufen |
PATCH | /api/crm/custom-fields/[id] | Name oder Auswahloptionen eines Felds aktualisieren |
DELETE | /api/crm/custom-fields/[id] | Ein benutzerdefiniertes Feld löschen |
GET /api/crm/custom-fields
Rufen Sie alle benutzerdefinierten Felder ab, die in Ihrem CRM verfügbar sind. Die Antwort enthält eine Liste mit Feld-ID, Name, Typ und zugehörigem Entitätstyp.
Antwortfelder
Gibt an, ob die Anfrage erfolgreich verarbeitet wurde.
Enthält alle benutzerdefinierten Felder, die für Ihr CRM verfügbar sind.
Eindeutige Kennung des benutzerdefinierten Felds.
Anzeigename des Felds.
Feldtyp des benutzerdefinierten Felds.
CRM-Entität, für die das Feld gilt. Mögliche Werte sind contact, company und opportunity.
POST /api/crm/custom-fields
Erstellen Sie ein neues benutzerdefiniertes Feld für Kontakte, Unternehmen oder Opportunities. Für Auswahlfelder übergeben Sie zusätzlich eine Liste von Optionen.
Body-Parameter
Name des benutzerdefinierten Felds, wie er im CRM angezeigt wird.
Definiert den Feldtyp. Verwenden Sie options nur, wenn type den Wert select hat.
textnumberdateselectbooleanLegt fest, für welche CRM-Entität das Feld verfügbar ist.
contactcompanyopportunityListe der auswählbaren Werte für Felder vom Typ select.
Antwortfelder
Gibt an, ob das Feld erfolgreich erstellt wurde.
Enthält das neu erstellte benutzerdefinierte Feld.
Eindeutige Kennung des neu erstellten Felds.
Anzeigename des Felds.
Feldtyp des benutzerdefinierten Felds.
CRM-Entität, für die das Feld erstellt wurde.
GET /api/crm/custom-fields/[id]
Rufen Sie ein einzelnes benutzerdefiniertes Feld über seine ID ab. Dieser Endpunkt eignet sich, wenn Sie vor einer Bearbeitung oder Löschung den aktuellen Zustand prüfen möchten.
Pfadparameter
Eindeutige Kennung des benutzerdefinierten Felds.
Antwortfelder
Gibt an, ob die Anfrage erfolgreich war.
Enthält das angeforderte benutzerdefinierte Feld.
PATCH /api/crm/custom-fields/[id]
Aktualisieren Sie den Namen eines Felds oder die Auswahloptionen eines vorhandenen Auswahlfelds. Andere Feldeigenschaften werden von diesem Endpunkt nicht dokumentiert.
Pfadparameter
Eindeutige Kennung des zu aktualisierenden Felds.
Body-Parameter
Neuer Anzeigename des benutzerdefinierten Felds.
Aktualisierte Auswahlwerte für ein Feld vom Typ select.
Antwortfelder
Gibt an, ob das Feld erfolgreich aktualisiert wurde.
Enthält das aktualisierte benutzerdefinierte Feld.
DELETE /api/crm/custom-fields/[id]
Löschen Sie ein benutzerdefiniertes Feld dauerhaft über seine ID. Die Antwort enthält nur die Erfolgsbestätigung.
Pfadparameter
Eindeutige Kennung des zu löschenden Felds.
Antwortfelder
Gibt an, ob das Feld erfolgreich gelöscht wurde.