Konverte Digital icon

Konverte Digital

Interact with Konverte Digital API

Actions115

Overview

This node operation allows users to add a new custom attribute to an account in the Konverte Digital system. It is useful for scenarios where additional metadata or custom fields need to be associated with an account, such as adding personalized tags, notes, or specific attribute values that are not part of the default account schema. For example, a user might add a custom attribute to track customer preferences or account-specific settings.

Use Case Examples

  1. Adding a custom attribute 'Loyalty Level' with a display type of 'text' to an account to segment customers.
  2. Adding a 'Subscription Expiry Date' attribute with a date display type to track account subscription status.

Properties

Name Meaning
Account Id The numeric ID of the account to which the custom attribute will be added.
Attribute Display Name The display name of the custom attribute as it will appear in the system.
Attribute Display Type The type of the attribute display, indicating how the attribute value should be interpreted or shown (e.g., text, number, currency, percent, link, date, list, checkbox).
Attribute Description A description providing additional details about the custom attribute.
Attribute Key A unique key value identifying the custom attribute.
Attribute Values The values associated with the custom attribute, provided in JSON format.
Attribute Model The attribute type indicating the context of the attribute, such as conversation attribute or contact attribute.
Request Options Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration to control how the API request is made.

Output

JSON

  • id - The unique identifier of the newly created custom attribute.
  • account_id - The account ID to which the custom attribute was added.
  • attribute_display_name - The display name of the custom attribute.
  • attribute_display_type - The display type of the custom attribute.
  • attribute_description - The description of the custom attribute.
  • attribute_key - The unique key of the custom attribute.
  • attribute_values - The values associated with the custom attribute.
  • attribute_model - The model type of the custom attribute (e.g., conversation or contact attribute).
  • created_at - Timestamp when the custom attribute was created.
  • updated_at - Timestamp when the custom attribute was last updated.

Dependencies

  • Requires an API key credential for authentication with the Konverte Digital API.

Troubleshooting

  • Common issues include invalid or missing account ID, which will cause the API to reject the request.
  • Incorrect attribute display type values may cause the attribute to not render correctly in the system.
  • Malformed JSON in attribute values can cause request failures; ensure valid JSON format.
  • SSL certificate validation errors can occur if the server uses a self-signed or invalid certificate; use the 'Ignore SSL Issues' option to bypass if necessary.
  • Timeouts may occur if the server is slow to respond; adjust the timeout setting accordingly.

Discussion