CRM-Benutzerdefinierte Felder

Talkturo-CRM-Kontakte um benutzerdefinierte Felder erweitern — Text-, Zahlen-, Boolean-, Datums-, Auswahl- und Textarea-Felder mit Pflichtfeld-, Aktiv- und Sortierungs-Einstellungen erstellen.

curl -X GET "https://api.talkturo.com/api/crm/custom-fields?teamId=team_7f3a91c2&entityType=contact&includeInactive=true" \
  -H "Cookie: sb-access-token=example_session_token_9xmk7q2r"

{
  "success": true,
  "fields": [
    {
      "id": "cf_8d3a2f91",
      "teamId": "team_7f3a91c2",
      "entityType": "contact",
      "key": "industry_segment",
      "label": "Industry Segment",
      "fieldType": "select",
      "options": ["Enterprise", "Mid-market", "SMB"],
      "isRequired": false,
      "sortOrder": 10,
      "isActive": true
    },
    {
      "id": "cf_3b7c4e20",
      "teamId": "team_7f3a91c2",
      "entityType": "contact",
      "key": "renewal_date",
      "label": "Renewal Date",
      "fieldType": "date",
      "isRequired": true,
      "sortOrder": 20,
      "isActive": true
    }
  ]
}

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 '{
    "teamId": "team_7f3a91c2",
    "entityType": "contact",
    "key": "lead_source",
    "label": "Lead Source",
    "fieldType": "select",
    "options": ["Referral", "Website", "Partner"],
    "isRequired": false,
    "sortOrder": 30,
    "isActive": true
  }'

{
  "success": true,
  "field": {
    "id": "cf_b5f29410",
    "teamId": "team_7f3a91c2",
    "entityType": "contact",
    "key": "lead_source",
    "label": "Lead Source",
    "fieldType": "select",
    "options": ["Referral", "Website", "Partner"],
    "isRequired": false,
    "sortOrder": 30,
    "isActive": true
  }
}

curl -X PUT "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 '{
    "label": "Primary Lead Source",
    "fieldType": "select",
    "options": ["Referral", "Website", "Partner", "Event"],
    "isRequired": true,
    "sortOrder": 25,
    "isActive": true
  }'

{
  "success": true,
  "field": {
    "id": "cf_b5f29410",
    "teamId": "team_7f3a91c2",
    "entityType": "contact",
    "key": "lead_source",
    "label": "Primary Lead Source",
    "fieldType": "select",
    "options": ["Referral", "Website", "Partner", "Event"],
    "isRequired": true,
    "sortOrder": 25,
    "isActive": true
  }
}

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-Kontakte mit benutzerdefinierten Feldern erweitern

Benutzerdefinierte Felder ergänzen CRM-Kontakte um zusätzliche Datenpunkte. Über diese Endpunkte listen Sie Felder für ein Team auf, erstellen neue Felder, aktualisieren bestehende Felder und löschen nicht mehr benötigte Felder.

Alle Endpunkte in diesem Bereich verwenden Session-Authentifizierung. Eine API-Key-Authentifizierung wird für diese Endpunkte nicht unterstützt. Benutzerdefinierte Felder gelten derzeit ausschließlich für die Entität contact.

Unterstützte Feldtypen sind text, number, boolean, date, select und textarea. Das Feld options verwenden Sie für Felder vom Typ select.

Endpunkte im Überblick

Methode	Pfad	Zweck
`GET`	`/api/crm/custom-fields`	Benutzerdefinierte Kontaktfelder eines Teams auflisten
`POST`	`/api/crm/custom-fields`	Ein neues benutzerdefiniertes Kontaktfeld erstellen
`PUT`	`/api/crm/custom-fields/[id]`	Ein benutzerdefiniertes Kontaktfeld aktualisieren
`DELETE`	`/api/crm/custom-fields/[id]`	Ein benutzerdefiniertes Kontaktfeld löschen

GET /api/crm/custom-fields

Rufen Sie die benutzerdefinierten Kontaktfelder eines Teams ab. Verwenden Sie entityType=contact, um die Entität explizit anzugeben. Mit includeInactive=true beziehen Sie auch deaktivierte Felder in die Antwort ein.

Query-Parameter

query

teamIdstring

Required

ID des Teams, dessen benutzerdefinierte Kontaktfelder abgerufen werden sollen.

query

entityTypestring

Filtert die Ergebnisse nach Entität. Der einzige unterstützte Wert ist contact.

Allowed values:contact

query

includeInactiveboolean

Wenn true, enthält die Antwort auch deaktivierte Felder. Ohne diesen Parameter werden nur aktive Felder zurückgegeben.

Antwortfelder

successboolean

Required

Gibt an, ob die Anfrage erfolgreich verarbeitet wurde.

fieldsarray

Required

Enthält die benutzerdefinierten Kontaktfelder, die den Query-Filtern entsprechen.

idstring

Required

Eindeutige Kennung des benutzerdefinierten Felds.

teamIdstring

Required

ID des Teams, dem das Feld zugeordnet ist.

entityTypestring

Required

Entität, für die das Feld gilt. Der Wert ist immer contact.

keystring

Required

Stabiler Schlüssel, unter dem der Feldwert gespeichert und abgerufen wird.

labelstring

Required

Anzeigename des Felds.

fieldTypestring

Required

Datentyp des Felds. Mögliche Werte sind text, number, boolean, date, select und textarea.

optionsarray

Auswahlwerte für Felder vom Typ select.

isRequiredboolean

Required

Gibt an, ob das Feld beim Erfassen eines Kontakts ausgefüllt werden muss.

sortOrdernumber

Required

Position des Felds in der Anzeige.

isActiveboolean

Required

Gibt an, ob das Feld aktiv ist und standardmäßig in den Ergebnissen erscheint.

POST /api/crm/custom-fields

Erstellen Sie ein benutzerdefiniertes Kontaktfeld für ein Team. Der Wert key sollte stabil bleiben, während Sie den sichtbaren Namen später über label ändern können.

CRM-Benutzerdefinierte Felder

CRM-Kontakte mit benutzerdefinierten Feldern erweitern

Endpunkte im Überblick

GET /api/crm/custom-fields

Query-Parameter

Antwortfelder

POST /api/crm/custom-fields

Body-Parameter

Antwortfelder

PUT /api/crm/custom-fields/[id]

Pfadparameter

Body-Parameter

Antwortfelder

DELETE /api/crm/custom-fields/[id]

Pfadparameter

Antwortfelder

Verwandte Endpunkte