Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Overview

This node operation allows you to create a new custom field value within an account. It is useful when you want to dynamically add additional metadata or attributes to entities managed in your system by defining custom fields and assigning values to them. For example, you might use this to add a custom tag or category label to a customer profile or transaction record.

Typical scenarios include:

  • Adding user-defined labels or tags to accounts for better segmentation.
  • Extending default data models with extra information without changing the core schema.
  • Integrating with external systems that require custom identifiers or labels on certain records.

Properties

Name Meaning
Account Id Identifier of the account where the custom field value will be created.
Custom Field Id Identifier of the specific custom field to which the value belongs.
Label The label or name of the custom field value being created.
External Id (Optional) Unique identifier of the custom field value in an external system for reference.

Output

The node outputs JSON data representing the newly created custom field value. This typically includes details such as the assigned ID, label, and any other metadata returned by the API after creation. The output can be used downstream in workflows to reference or manipulate the created custom field value.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authentication with the external service managing custom fields.
  • 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 Label are provided; otherwise, the API call will fail.
  • Invalid Identifiers: Using incorrect or non-existent account or custom field IDs will result in errors from the API.
  • Authentication Errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • API Endpoint Issues: Confirm the base URL is correct and reachable from your n8n instance.
  • Duplicate External Ids: If using External Id, ensure it is unique to avoid conflicts.

Common error messages may include unauthorized access, resource not found, or validation errors indicating missing or invalid parameters.

Links and References

  • Refer to the external API documentation for custom fields management for detailed parameter descriptions and examples.
  • n8n documentation on how to configure API credentials and handle HTTP request nodes.

Discussion