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 your system, such as updating labels or external identifiers associated with those fields. For example, if you manage customer profiles and want to update a custom attribute like "Preferred Contact Method" or "Loyalty Tier," this operation allows you to programmatically change those values.

Properties

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

Output

The output JSON will contain the updated custom field value details after the operation completes successfully. This typically includes the identifiers and any updated properties such as the new label or external ID. The node does not output binary data.

Dependencies

  • Requires an API key credential or similar authentication token configured in n8n to authorize requests.
  • Depends on connectivity to the external service managing the custom fields (e.g., a CRM or custom backend API).
  • The base URL and headers for the API requests are expected to be set up in the node credentials or configuration.

Troubleshooting

  • Missing Required Fields: Ensure that Account Id, Custom Field Id, and Custom Field Value Id are provided; otherwise, the request will fail.
  • Authentication Errors: Verify that the API key or authentication token is correctly configured and has sufficient permissions.
  • Invalid Identifiers: If the IDs do not correspond to existing resources, the API will likely return a "not found" error.
  • Network Issues: Check network connectivity and endpoint availability if requests time out or fail.
  • API Response Errors: Review error messages returned by the API for clues, such as validation errors on the label or external ID fields.

Links and References

  • Refer to the external API documentation of the service managing custom fields for detailed information on the update endpoint and payload structure.
  • n8n documentation on how to configure API credentials and use HTTP Request nodes may also be helpful.

Discussion