Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Custom Fields → Create A Custom Field Value

AI-generated

Overview

This node operation allows users to create a new custom field value within an account. It is useful in scenarios where you want to extend the data model by adding additional metadata or attributes that are not part of the default schema. For example, if you manage customer accounts and want to add a custom tag or category to each account, this operation lets you define those custom values programmatically.

Practical examples include:

  • Adding a custom status label to an account.
  • Creating a unique identifier for integration with external systems.
  • Tagging accounts with specific labels for segmentation or reporting.

Properties

Name Meaning
Account Id Identifier of the account to which the custom field value will be added.
Custom Field Id Identifier of the custom field under which the value will be created.
Label The display 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 output JSON contains the details of the newly created custom field value. This typically includes the identifiers, label, and any metadata returned by the API confirming the creation. The node does not output binary data.

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.
  • Authentication Errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Invalid Identifiers: Double-check that the Account Id and Custom Field Id correspond to existing entities in the external system.
  • API Response Errors: If the external API returns errors, inspect the error message for details such as rate limits, invalid data formats, or server issues.

Links and References

  • Refer to the external API documentation for custom fields management for detailed information on required parameters and response structure.
  • n8n documentation on creating custom nodes and handling API credentials.

Discussion