Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

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.

Practical examples include:

  • Changing the label of a custom field value to reflect updated terminology.
  • Updating an external identifier for synchronization purposes with another system.
  • Correcting or modifying values linked to custom fields without recreating them.

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 after the update operation. This typically includes the updated properties such as the new label, external ID, and any other relevant metadata.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential or similar authentication token configured in n8n to authorize requests to the external service managing custom fields.
  • The node uses HTTP requests with JSON payloads to interact with the external API.
  • Base URL and authentication details must be set up in the node credentials configuration.

Troubleshooting

  • Missing Required Fields: Ensure that Account Id, Custom Field Id, and Custom Field Value Id are provided; otherwise, the API will reject the request.
  • 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 may return errors indicating not found or invalid parameters.
  • Partial Updates: Omitting optional fields like Label or External Id means those values remain unchanged; ensure you provide all intended updates.
  • API Rate Limits: Frequent updates might hit rate limits imposed by the external service; handle such errors by retrying after some delay.

Links and References

  • Refer to the external API documentation for custom fields management for detailed schema and error codes.
  • Consult n8n documentation on setting up API credentials and handling HTTP request nodes for more context on integration setup.

Discussion