v1Ressourcen/Custom Fields/putBenutzerdefinierten Feldwert setzen
Benutzerdefinierten Feldwert setzen
Setzt einen benutzerdefinierten Feldwert auf einem Standort oder Kunden. Übergeben Sie null (oder einen leeren Wert), um das Feld zu leeren. Der Wert wird gegen die Definition des Feldes validiert — bei einem select-Feld muss der Wert beispielsweise eine seiner definierten Optionen sein.
put
custom-fields:write/api/v1/custom-fields/valuesAnfragetext
entityTypestring (location | client)erforderlich
Der Entitätstyp, für den dieses Feld gilt: "location" oder "client".
entityIdstringerforderlich
ID des Standorts oder Kunden, auf dem der Wert gesetzt werden soll.
keystringerforderlich
Key der zu setzenden benutzerdefinierten Feld-Definition, wie in ihrer key-Eigenschaft zurückgegeben.
valueobjecterforderlich
Der zu speichernde Wert. Muss im Anfragetext vorhanden sein, kann aber null oder leer sein, um das Feld zu leeren. Wird gegen den Typ und die Optionen des Feldes validiert.
Antwort
dataobjectoptional
valuesobjectoptional
Die benutzerdefinierten Feldwerte der Entität, indiziert nach Feld-Key. Ein Wert ist eine Zeichenfolge, eine Zahl, ein Array von Zeichenfolgen (bei multi_select) oder nicht vorhanden, wenn nicht gesetzt.
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.
put/api/v1/custom-fields/values
Ihr API-Schlüssel
Anfragetext*
{
"data": {
"values": {
"parking_notes": "Free lot behind the building."
}
}
}