Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Overview

This node operation updates an existing custom field within a specified account. It allows users to modify properties such as the label, description, type, and other metadata of a custom field. This is useful in scenarios where the structure or requirements of data collection need to be changed dynamically without recreating fields from scratch.

Practical examples include:

  • Changing the label of a custom field to better reflect its purpose.
  • Updating whether a custom field is required or optional.
  • Modifying the type of input expected (e.g., switching from a free text input to a predefined list).
  • Adding or updating external identifiers for integration with other systems.

Properties

Name Meaning
Account Id Identifier of the account where the custom field exists.
Custom Field Id Identifier of the custom field to update.
Label The new label/name for the custom field.
Is Required Boolean indicating if the custom field must always have a value (true = required).
Description A textual description explaining the purpose or details of the custom field.
External Id Unique identifier of the custom field in an external system for integration purposes.
External Source Unique identifier of the external system that owns or manages this custom field.
Type The type of the custom field. Options are: Dynamic List, Predefined List, Free Text Input, Date.

Output

The node outputs JSON data representing the updated custom field object as returned by the API. This typically includes all the updated properties such as label, type, description, and identifiers. The output can be used downstream in workflows to confirm changes or trigger further actions.

No binary data output is indicated.

Dependencies

  • Requires an API key credential or similar authentication token configured in n8n to connect to the external service managing custom fields.
  • The base URL for the API must be set in the credentials configuration.
  • The node depends on an external REST API that supports updating custom fields via HTTP requests.

Troubleshooting

  • Missing Required Fields: Errors may occur if Account Id or Custom Field Id are not provided. Ensure these are correctly set.
  • Invalid Field Types: Setting an unsupported type value may cause API errors. Use only the provided options.
  • Authentication Failures: If the API key or credentials are invalid or missing, the request will fail. Verify credential setup.
  • API Endpoint Issues: Network problems or incorrect base URL configurations can prevent successful updates.
  • Permission Denied: The authenticated user might lack permissions to update custom fields in the specified account.

To resolve errors:

  • Double-check all required inputs.
  • Confirm API credentials and endpoint URLs.
  • Review API documentation for permission requirements and valid field values.

Links and References

  • Refer to the external API documentation for detailed information on custom field management and update operations.
  • n8n documentation on setting up API credentials and using HTTP request nodes may provide additional context.

Discussion