Magidoc

deleteCustomField
Mutation

Permanently deletes a custom field from the workspace.

This mutation removes a custom field definition and optionally removes all existing values of this field from actions and projects. This is a destructive operation that cannot be undone.

Access: Requires workspace admin access

Returns: The deleted CustomField object (marked as deleted)

Errors:

  • Throws error if user doesn't have workspace admin access
  • Throws error if custom field doesn't exist
  • Throws error if custom field is already deleted

Arguments

#

customFieldId

ID !
Non-null

The ID of the custom field to delete

shouldRemoveExistingValues

Boolean !
Non-null

Whether to remove existing field values from all actions/projects

Response

#

Returns CustomField .

Example

#