Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Custom Fields → Delete A Custom Field And All Its Values

AI-generated

Overview

This node operation deletes a specified custom field and all its associated values from an account. It is useful in scenarios where you want to clean up or remove obsolete or incorrect custom fields from your data management system, ensuring that no residual data remains linked to the deleted field.

Practical examples include:

  • Removing a deprecated custom field used for user preferences that is no longer relevant.
  • Cleaning up custom fields after a data migration or restructuring process.
  • Ensuring compliance by deleting sensitive custom fields and their data.

Properties

Name Meaning
Account Id Identifier of the account from which the custom field will be deleted.
Custom Field Id Identifier of the custom field to delete along with all its values.

Output

The output JSON typically contains confirmation details about the deletion operation. This may include status messages or identifiers confirming that the custom field and its values were successfully removed. The node does not output binary data.

Dependencies

  • Requires an API key credential or similar authentication token configured in n8n to authorize requests to the external service managing custom fields.
  • The node interacts with an external API endpoint (base URL provided via credentials) to perform the deletion.
  • Proper network connectivity and permissions are necessary to access and modify the account's custom fields.

Troubleshooting

  • Common Issues:

    • Invalid or missing Account Id or Custom Field Id can cause the operation to fail.
    • Insufficient permissions or invalid API credentials may result in authorization errors.
    • Network issues or incorrect base URL configuration can prevent successful API calls.
  • Error Messages:

    • "Custom field not found": Verify that the Custom Field Id is correct and exists in the specified account.
    • "Unauthorized" or "Authentication failed": Check that the API key or authentication token is valid and properly configured.
    • "Network error" or "Timeout": Ensure stable internet connection and correct API endpoint URL.

Resolving these errors usually involves verifying input parameters, checking credential validity, and confirming network settings.

Links and References

  • Refer to the external API documentation for managing custom fields for detailed information on required parameters and response formats.
  • n8n documentation on setting up API credentials and handling HTTP request nodes may provide additional guidance.

Discussion