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 of 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, used for integration purposes.
External Source Identifier of the external system associated with this custom field.
Type The type of the custom field. Options: 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, requirement status, and any external identifiers.

If the node supports binary data output, it would represent related file or media content, but based on the provided code and properties, this operation deals only with JSON data.

Dependencies

  • Requires an API key credential for authenticating requests to the external service managing custom fields.
  • The node uses a base URL configured in credentials to send HTTP requests.
  • Depends on the external API's availability and correct configuration of account and custom field identifiers.

Troubleshooting

  • Invalid Account Id or Custom Field Id: Errors may occur if these identifiers do not exist or are mistyped. Verify the IDs before running the node.
  • Missing Required Fields: The "Label" and "Is Required" properties are mandatory; omitting them will cause validation errors.
  • API Authentication Failures: Ensure that the API key or authentication token is correctly set up in the node credentials.
  • Unsupported Type Values: Only the specified types ("dynamic_list", "predefined_list", "free_text_input", "date") are accepted. Using unsupported values will result in errors.
  • Network Issues: Connectivity problems with the external API endpoint can cause timeouts or failures.

Links and References

  • Refer to the external API documentation for detailed information about custom field management and supported operations.
  • n8n documentation on creating and configuring nodes with API credentials and HTTP request handling.

Discussion