How to create and use custom attributes?

Yuzap allows you to add custom attributes to track extra information about contacts and conversations, beyond the standard data.

Yuzap allows tracking additional information about your conversations and contacts, beyond standard data attributes like name, email, and location. These additional pieces of information are called custom attributes and can be anything you want to track. Below are some examples of custom attributes.

• Subscription plan

• Subscription date

• Registration date

• Most ordered item

• Ordered product link

• Date of last transaction

Custom data attributes allow attaching additional information to a conversation or customer, such as purchase history or account status. This information can be used to better understand and segment your customer base.

The only difference between custom and standard attributes is that standard data attributes are updated automatically.

How to create a custom attribute?

Step 1. Go to Settings → Custom Attributes. Click the button “Add Custom Attribute.”

Step 2. A modal window will open requesting details about the new custom attribute. Fill in those details. Here is an example:

These are the required entries to create the custom attribute:

1. Applies to Attribute type (Conversation/Contact).

2. Display name Acts as a label when rendering the custom attribute.

3. Key Unique identifier attached to the custom attribute.

4. Description Custom attribute description.

5. Type Text, Number, Link, Date, List, and Checkbox.

Note: You cannot create a custom attribute with the same key twice in the account.

Step 3. After entering the details, click the button ”Create”. If the request is successful, a message "Custom attribute added successfully" will be displayed.

How to use a conversation custom attribute?

You can add conversation custom attributes to a conversation from the conversation sidebar. Follow the steps described below.

Step 1. In your dashboard, when opening a specific conversation, you will find a section called “Conversation Information”. Click the sign + to expand it.

Step 2. You will see an option called “Add Attributes” followed by a dropdown of all Custom Attributes in your account. Use the search bar to filter by the attribute name you are looking for. Or click one to select it. If you need to create a new one, use the “Create new attribute” button in the same dropdown.

To edit/delete/copy an attribute, hover over it to see the options.

How to use a contact custom attribute?

There are two ways to set custom attributes for contacts.

Set attributes via SDK method

To set a contact custom attribute, call the setCustomAttributes method as follows.

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

Example:

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

You can view these attributes in the contact/conversation sidebar.

To delete a custom attribute, use deleteCustomAttribute method as follows.

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

Example:

window.$yuzap.deleteCustomAttribute("registrationDate");

Note: Before version v1.22, all attributes were rendered as text. Please create a new definition to display the value correctly.

Set attributes via the contact sidebar

To add Contact Attributes, follow the same procedure described above for conversation custom attributes, but use the Contact Attributes section of the chat sidebar.

Based on the type of attribute you added (list, checkbox, text, etc.), fill it in as desired. Here is an example: