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 custom fields need to be maintained or adjusted dynamically based on evolving business requirements, for example updating the label or making a field required after initial creation.

Practical examples:

  • Renaming a custom field label to better reflect its purpose.
  • Changing a custom field from optional to required.
  • Updating the external system identifiers to keep synchronization consistent.

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 that owns or syncs this custom field.
Type Type of the custom field. Options include: 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 of the custom field such as its id, label, type, description, and flags like whether it is required.

If the node supports binary data output, it would generally relate to file attachments or similar, but this operation focuses on JSON metadata updates only.

Dependencies

  • Requires an API key credential or equivalent authentication token configured in n8n to authorize requests to the external service managing custom fields.
  • The node depends on a REST API endpoint that accepts PATCH or PUT requests to update custom field resources.
  • Proper base URL configuration for the API endpoint is necessary.

Troubleshooting

  • Missing Required Fields: Errors may occur if Account Id or Custom Field Id are not provided or invalid. Ensure these IDs are correct and exist.
  • Invalid Field Types: Setting an unsupported type value will cause validation errors. Use one of the predefined options.
  • Authentication Failures: If the API key or credentials are missing or incorrect, the request will fail with authorization errors.
  • Network Issues: Connectivity problems can cause timeouts or unreachable host errors.
  • API Limitations: Some APIs may restrict updates on certain fields or require specific formats; check API documentation for constraints.

Links and References

  • Refer to the external API documentation for custom fields management for detailed schema and update rules.
  • n8n documentation on how to configure API credentials and use HTTP Request nodes for custom integrations.

Discussion