Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

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 dynamically via custom fields. For example, if you manage customer accounts and want to add specific tags or labels that are not part of the default schema, this operation lets you define those values programmatically.

Practical examples include:

  • Adding a new status label to a customer profile.
  • Creating a custom tag for categorizing transactions.
  • Defining unique identifiers for integration with external systems.

Properties

Name Meaning
Account Id Identifier of the account where the custom field value will be created.
Custom Field Id Identifier of the custom field to which this value belongs.
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 assigned ID, label, and any other metadata returned by the API after creation. 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 the external service's REST API endpoint for managing custom fields.
  • The base URL for the API must be set in the node credentials or environment configuration.

Troubleshooting

  • Missing Required Fields: If "Account Id", "Custom Field Id", or "Label" are not provided, the node will likely throw validation errors. Ensure all required properties are filled.
  • Authentication Errors: If the API key or authentication token is invalid or missing, the node will fail to connect. Verify credentials are correctly set.
  • Invalid Identifiers: Providing incorrect account or custom field IDs may result in "not found" errors from the API. Double-check these values.
  • API Rate Limits: Excessive requests might trigger rate limiting; consider adding delays or retries.

Links and References

  • Refer to the external API documentation for custom fields management for detailed information on request/response formats and error codes.
  • n8n documentation on how to configure API credentials and use HTTP Request nodes for custom integrations.

Discussion