Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Custom Fields → Update Custom Field

AI-generated

Overview

This node operation updates an existing custom field within a specified account. It allows users to modify attributes 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:

  • Renaming a custom field label to better reflect its purpose.
  • Changing a custom field's type from a free text input to a predefined list for standardized responses.
  • Updating the description to provide clearer instructions to end-users.
  • Marking a custom field as required or optional based on new business rules.

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 display name or label of the custom field.
Is Required Boolean indicating if the custom field must always have a value (true = required, false = optional).
Description Text describing the purpose or details of the custom field.
External Id Unique identifier of the custom field in an external system, if applicable.
External Source Identifier of the external system associated with 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 properties of the custom field after the update, such as its ID, label, type, description, requirement status, and any external identifiers.

If the node supports binary data output, it would generally relate to file attachments or media linked to the custom field, but no such binary output is indicated here.

Dependencies

  • Requires an API key credential for authenticating requests to the external service managing custom fields.
  • The base URL for the API must be configured in the node credentials.
  • The node depends on an OpenAPI-based client library for request construction and response parsing.

Troubleshooting

  • Missing Required Fields: Errors may occur if Account Id or Custom Field Id are not provided. Ensure these are set correctly.
  • Invalid Field Type: Selecting a type outside the allowed options will cause validation errors.
  • Authentication Failures: If the API key or base URL is incorrect or missing, the node will fail to connect.
  • API Errors: The external service might return errors if the custom field does not exist or if the user lacks permissions. Check API response messages for details.
  • Network Issues: Connectivity problems can cause timeouts or failed requests.

To resolve common errors:

  • Verify all required inputs are filled.
  • Confirm API credentials and endpoint URLs.
  • Review API documentation for permission requirements.
  • Inspect error messages returned by the node for specific causes.

Links and References

Discussion