Custom Attributes

Neoleads supports custom attributes in addition to the standard data attributes (a default set of data about your conversations/contacts like Name, Email, Location, etc.). Custom attributes serve to track specific details about your contacts and conversations. These custom attributes can encompass a wide range of information, such as:

1. Subscription plan

2. Subscribed date

3. Signup date

4. Most ordered item

5. Ordered product link

6. Last transaction date

The primary distinction between custom and standard attributes lies in how they are updated. Standard data attributes are automatically updated, while custom data attributes are user-defined and can include information such as the number of product orders, signup dates, or subscription plans. These custom attributes allow you to tailor your understanding of your customers and conversations, all within Neoleads.

Add a new custom attribute

To add a new custom attribute in Neoleads, follow these steps:

1. Navigate to the Custom Attributes section by clicking on 'Settings' -> 'Custom Attributes' in the sidebar.

custom-attribute-list

Click the 'Add custom attributes' button located in the top right corner of the page, which will open a modal as illustrated below.

add-custom-attribute

Here are the details required to create a custom attribute:

Input	Description
Applies to	Attribute type (Conversation/Contact)
Display name	Act as a label while rendering custom attribute
Description	Description about the custom attribute
Type	Type of data it will store. Currently supports Text, Number, Link, and Date
Key	Unique identifier attach to the custom attribute

Note that you cannot create a custom attribute with the same key twice in the account.

Once you enter the details, click on the Create button. If the request is successful, a message "Custom attribute added successfully" will be displayed.

Conversation custom attributes​

1

1. Set attributes via SDK method: You can set custom attributes for each conversation using the SDK. Use the setConversationCustomAttributes method to add custom attributes and the deleteConversationCustomAttribute method to remove them.

2. Set attributes via the conversation side panel: After creating a conversation custom attribute, you can add it to a conversation via the conversation sidebar.

add-conversation-attribute

Simply open the attribute dropdown selector, choose the attribute you want to add, enter a valid value, and click 'Create.'

add-conversation-attribute

If successful, a message confirming that the attribute was added will be displayed.

add-conversation-attribute

Also you could able see the actions like edit/delete/copy by hovering on the attribute.

attribute-actions

Contact custom attributes​

There two ways for setting custom attributes for contacts

1. Set attributes via SDK method​

To set a contact custom attributes call setCustomAttributes method as follows,

window.$chatwoot.setCustomAttributes({
  key: value,
  // Key is a unique identifier which is already defined while creating a custom attribute
  // Value should be based on type (Currently support Number, Date, String and Number)
  // Double-check that your keys always have a JSON-valid value
  // You need to flatten nested JSON structure while using this function
});

Ex:

window.$chatwoot.setCustomAttributes({
  plan: "premium",
  signUpDate: new Date(),
});

You can view these attributes in the contact side panel

To delete a custom attribute, use deleteCustomAttribute as follows

window.$chatwoot.deleteCustomAttribute("attribute-key");

Ex:

window.$chatwoot.deleteCustomAttribute("signUpDate");

Prior to version v1.22 , all the attributes rendered as text. Please create new definition to display the value properly

2. Set attributes via contact side panel​

After creating contact custom attribute, you will be able to add these attribute to the contact via conversation/contact sidebar.

add-contact-attribute

It will open a attribute dropdown selector, then select the attribute that you want to add

add-contact-attribute

Enter a valid value, click on the Create button. If the request is successful, a message "Attribute added successfully" will be displayed.

add-contact-attribute

Also you could able see the actions like edit/delete/copy by hovering on the attribute.

contact-attribute-actions