Synupv1
Schlüssel erstellen
v1Ressourcen/Custom Fields/patchBenutzerdefinierte Feld-Definition aktualisieren

Benutzerdefinierte Feld-Definition aktualisieren

Bearbeitet das label, das required-Flag, die options oder die Anzeigereihenfolge einer benutzerdefinierten Feld-Definition. Der Typ und der key des Feldes können nach der Erstellung nicht mehr geändert werden.

patch/api/v1/custom-fields/definitions
custom-fields:write
Anfragetext
definitionIdstringerforderlich
ID der zu aktualisierenden benutzerdefinierten Feld-Definition.
labelstringoptional
Das Anzeigelabel des benutzerdefinierten Feldes.
requiredbooleanoptional
Ob das Feld als erforderlich markiert werden soll. Optional; Standardmäßig false.
optionsarray of stringoptional
Die auswählbaren Optionen des Feldes. Erforderlich (mindestens eine) für Felder des Typs single_select und multi_select; wird für andere Typen ignoriert.
ordernumberoptional
Neue Anzeigereihenfolge für diese Definition relativ zu anderen desselben Entitätstyps.
Antwort
dataobjectoptional
definitionobjectoptional
idstringoptional
Eindeutige Kennung der benutzerdefinierten Feld-Definition.
entityTypestring (location | client)optional
Der Entitätstyp, für den diese Definition gilt: "location" oder "client".
keystringoptional
Unveränderlicher Slug, der dieses Feld identifiziert, abgeleitet von seinem label bei der Erstellung. Verwenden Sie dies, um das Feld beim Setzen von Werten zu referenzieren.
labelstringoptional
Das Anzeigelabel des benutzerdefinierten Feldes.
typestring (text | number | date | single_select | multi_select)optional
Der Werttyp des Feldes.
requiredbooleanoptional
Ob das Feld als erforderlich markiert ist. Dies wird von der API nicht erzwungen — es ist nur ein Hinweis für die Benutzeroberfläche.
optionsarray of stringoptional
Die auswählbaren Optionen des Feldes, für Felder des Typs single_select und multi_select. Null für andere Typen.
createdBystringoptional
Wer diese Feld-Definition erstellt hat: "user" oder "agent".
ordernumberoptional
Die Anzeigereihenfolge des Feldes relativ zu anderen Definitionen desselben Entitätstyps, niedrigste zuerst.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
422Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
patch/api/v1/custom-fields/definitions
Ihr API-Schlüssel
Anfragetext*
{
  "data": {
    "definition": {
      "id": "cm_def_abc123",
      "entityType": "location",
      "key": "parking_notes",
      "label": "Parking notes",
      "type": "text",
      "required": true,
      "options": null,
      "createdBy": "user",
      "order": 0
    }
  }
}