Synupv1
Create a key
v1Resources/Custom Fields/deleteArchive a custom field definition

Archive a custom field definition

Archives a custom field definition so it no longer appears in the schema or accepts new values. Values already stored under its key are left untouched. An unknown or already-archived definitionId is a no-op, not an error.

delete/api/v1/custom-fields/definitions
custom-fields:write
Query parameters
definitionIdstringrequired
ID of the custom field definition to archive.
Response
dataobjectoptional
archivedbooleanoptional
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
429Too many requests. Retry after the number of seconds in the Retry-After header.
delete/api/v1/custom-fields/definitions
Your API key
definitionId *
{
  "data": {
    "archived": true
  }
}