Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Custom Fields → Update A Custom Field Value

AI-generated

Overview

This node operation updates the value of a specific custom field within an account. It is useful when you need to modify metadata or additional information stored as custom fields in an external system, such as updating labels or identifiers associated with those fields. For example, you might use this node to rename a custom field value label or synchronize an external identifier after changes in another system.

Properties

Name Meaning
Account Id Identifier of the account where the custom field exists.
Custom Field Id Identifier of the custom field to update.
Custom Field Value Id Identifier of the specific custom field value to update.
Label (Optional) New label for the custom field value.
External Id (Optional) Unique identifier of the custom field value in the external system.

Output

The node outputs JSON data representing the updated custom field value object returned from the API. This typically includes the updated properties such as the new label and external ID, along with identifiers confirming the update. The output does not include binary data.

Dependencies

  • Requires an API key credential for authentication with the external service.
  • The base URL for the API must be configured in the node credentials.
  • The node uses standard HTTP headers for JSON content type and accepts JSON responses.

Troubleshooting

  • Missing Required Fields: Ensure that Account Id, Custom Field Id, and Custom Field Value Id are provided; otherwise, the API call will fail.
  • Invalid Identifiers: If any of the IDs do not correspond to existing resources, the API may return a "not found" error.
  • Authentication Errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Label or External Id Format Issues: If the label or external ID values do not meet the external system's validation rules, the update may be rejected.

Links and References

  • Refer to the external system’s API documentation for details on custom fields and their values.
  • n8n documentation on creating and using API credentials.

Discussion