v1Ressourcen/Custom Fields/deleteBenutzerdefinierte Feld-Definition archivieren

Benutzerdefinierte Feld-Definition archivieren

Archiviert eine benutzerdefinierte Feld-Definition, sodass sie nicht mehr im Schema erscheint und keine neuen Werte mehr akzeptiert. Bereits unter ihrem key gespeicherte Werte bleiben unberührt. Eine unbekannte oder bereits archivierte definitionId führt zu keiner Aktion (kein Fehler).

delete/api/v1/custom-fields/definitions

custom-fields:write

Query-Parameter

definitionIdstringerforderlich

ID der zu archivierenden benutzerdefinierten Feld-Definition.

Antwort

dataobjectoptional

archivedbooleanoptional

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.

429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.

delete/api/v1/custom-fields/definitions

Ihr API-Schlüssel

definitionId *

{
  "data": {
    "archived": true
  }
}