Custom Attributes

​

Accessing Custom Attributes

1. In the left sidebar menu, click Settings.
2. In the settings options list, select Custom Attributes.

​

Attribute Categories

• Conversations: Attributes applied to conversations
• Contacts: Attributes applied to contacts
• Pipeline: Attributes applied to pipelines, stages, or items

​

Searching Custom Attributes

​

How to search

1. At the top of the screen, locate the “Search custom attributes…” field with the search icon
2. Type the name, description, or key of the desired attribute
3. The attributes table will be automatically updated as you type, showing only attributes that match the search

​

Viewing Custom Attributes in the Table

​

Table Columns

• Name: Display name of the custom attribute
  • Displays the name defined during creation (e.g., “Lead Priority”, “Position”, “Contact Reason”)
  • The column is sortable (indicated by up/down arrows)
• Description: Complete description of the attribute
  • Displays the description defined during creation
  • Helps understand the attribute’s purpose
• Type: Data type of the attribute
  • Displayed in a blue tag (e.g., “Text”, “Number”, “Date”)
  • Indicates the data format accepted by the attribute
• Key: Technical key of the attribute
  • Displayed in a gray tag (e.g., “lead_priority”, “position”, “contact_reason”)
  • Used to identify the attribute in the API
• Values: Predefined values (if applicable)
  • Displays predefined values for list or selection type attributes
  • Shows ”-” when not applicable
• Regex: Indicates if the attribute has validation by regular expression
  • Displayed in a green tag with “Yes” when regex is configured
  • Displayed as ”-” when there is no regex validation
• Created at: Attribute creation date
  • Displays the date in DD/MM/YYYY format (e.g., “23/01/2026”)
  • The column is sortable (indicated by up/down arrows)
• Model: Model to which the attribute applies (only for Pipeline)
  • Displays “Item”, “Stage”, or “Pipeline” for pipeline attributes
  • Not displayed for Conversations or Contacts attributes
• Actions: Action menu to manage the attribute
  • Three horizontal dots icon (...) that opens a dropdown menu with options
  

​

Table Features

• Sorting: Name and Created at columns can be sorted by clicking the header
• Integrated Search: The search bar above the table filters results in real-time
• Category Filter: Use tabs (Conversations, Contacts, Pipeline) to filter attributes by category
• Counter: The total number of attributes in the current category is displayed below the title

​

Attributes for Conversations

​

Creating a Conversation Attribute

1. On the Custom Attributes screen, click the “Conversations” tab to filter only conversation attributes
2. Click the green ”+ New Custom Attribute” button in the top right corner of the screen
3. A modal will be displayed with the title “New Custom Attribute”

​

Filling Out the Form

• Select “Conversations” in the dropdown
• The help text will display: “Attributes applied to conversations”

• Type a friendly name that will be displayed to users
• Example: “Contact Reason”

• The technical key will be automatically generated from the Display Name
• Use only lowercase letters, numbers, and underscores
• Example: contact_reason

• Explain the attribute’s purpose
• Example: “Identify the main reason why the customer contacted you.”

• Select the data type (Text, Number, Date, Boolean, List)
• For the “Contact Reason” example, select “Text”

• Activate the toggle if you want to validate the text format
• Example Regex Pattern: ^.{5,}$ (minimum 5 characters)
• Example Regex Cue: “Describe the reason for contacting us (minimum 5 characters).”

​

Finalizing Creation

1. Review the entered information
2. Verify that regex validation is configured correctly (if applicable)
3. Click the green “Create” button to create the attribute
4. The attribute will be created and will appear in the Conversations attributes table

​

Editing a Conversation Attribute

1. In the attributes table, make sure the “Conversations” tab is selected
2. Locate the attribute you want to edit
3. In the Actions column, click the three dots icon (...)
4. In the dropdown menu, click Edit (pencil icon)
5. A modal will open with the title “Edit Custom Attribute” and fields already filled
6. Modify the desired fields:
   • Display Name
   • Description
   • Type (be careful when changing, as it may affect existing data)
   • Regex Validation (activate/deactivate or modify pattern and cue)
7. Click the green “Update” button to save the changes

​

Deleting a Conversation Attribute

1. In the attributes table, locate the attribute you want to delete
2. In the Actions column, click the three dots icon (...)
3. In the dropdown menu, click Delete (trash icon in red)
4. Confirm the deletion in the dialog that appears

​

Attributes for Contacts

​

Creating a Contact Attribute

1. On the Custom Attributes screen, click the “Contacts” tab to filter only contact attributes
2. Click the green ”+ New Custom Attribute” button in the top right corner of the screen
3. A modal will be displayed with the title “New Custom Attribute”

​

Filling Out the Form

• Select “Contacts” in the dropdown
• The help text will display: “Attributes applied to contacts”

• Type a friendly name that will be displayed to users
• Example: “Position”

• The technical key will be automatically generated from the Display Name
• Use only lowercase letters, numbers, and underscores
• Example: position

• Explain the attribute’s purpose
• Example: “Indicates the contact’s position or role within the company.”

• Select the data type (Text, Number, Date, Boolean, List)
• For the “Position” example, select “Text”

• Activate the toggle if you want to validate the text format
• Example Regex Pattern: ^.{2,}$ (minimum 2 characters)
• Example Regex Cue: “Please provide the contact’s job title (minimum 2 characters).”

​

Finalizing Creation

1. Review the entered information
2. Verify that regex validation is configured correctly (if applicable)
3. Click the green “Create” button to create the attribute
4. The attribute will be created and will appear in the Contacts attributes table

​

Editing a Contact Attribute

1. In the attributes table, make sure the “Contacts” tab is selected
2. Locate the attribute you want to edit
3. In the Actions column, click the three dots icon (...)
4. In the dropdown menu, click Edit (pencil icon)
5. A modal will open with the title “Edit Custom Attribute” and fields already filled
6. Modify the desired fields
7. Click the green “Update” button to save the changes

​

Deleting a Contact Attribute

1. In the attributes table, locate the attribute you want to delete
2. In the Actions column, click the three dots icon (...)
3. In the dropdown menu, click Delete (trash icon in red)
4. Confirm the deletion in the dialog that appears

​

Attributes for Pipeline

​

Creating a Pipeline Attribute

1. On the Custom Attributes screen, click the “Pipeline” tab to filter only pipeline attributes
2. Click the green ”+ New Custom Attribute” button in the top right corner of the screen
3. A modal will be displayed with the title “New Custom Attribute”

​

Filling Out the Form

• Select “Pipeline” in the dropdown
• The help text will display: “Attributes applied to pipelines, stages or items”
• Important: When “Pipeline” is selected, an additional “Pipeline Type” field will be displayed

• Select one of the options:
  • Pipeline: Attributes applied to the pipeline as a whole
  • Stage: Attributes applied to pipeline stages
  • Item: Attributes applied to pipeline items (deals/leads)
• Example: For “Lead Priority”, select “Item”
• The help text will display: “Attributes applied to items (deals/leads) of the pipeline”

• Type a friendly name that will be displayed to users
• Example: “Lead Priority”

• The technical key will be automatically generated from the Display Name
• Use only lowercase letters, numbers, and underscores
• Example: lead_priority

• Explain the attribute’s purpose
• Example: “Define the priority of the opportunity in the sales pipeline.”

• Select the data type (Text, Number, Date, Boolean, List)
• For the “Lead Priority” example, select “Text”

• Activate the toggle if you want to validate the text format
• Example Regex Pattern: ^(Low|Medium|High)$ (accepts only “Low”, “Medium”, or “High”)
• Example Regex Cue: “Use only: Low, Medium or High”

​

Finalizing Creation

1. Review the entered information, especially the Pipeline Type
2. Verify that regex validation is configured correctly (if applicable)
3. Click the green “Create” button to create the attribute
4. The attribute will be created and will appear in the Pipeline attributes table

​

Editing a Pipeline Attribute

1. In the attributes table, make sure the “Pipeline” tab is selected
2. Locate the attribute you want to edit
3. In the Actions column, click the three dots icon (...)
4. In the dropdown menu, click Edit (pencil icon)
5. A modal will open with the title “Edit Custom Attribute” and fields already filled
6. Modify the desired fields:
   • Pipeline Type (if necessary)
   • Display Name
   • Description
   • Type (be careful when changing, as it may affect existing data)
   • Regex Validation (activate/deactivate or modify pattern and cue)
7. Click the green “Update” button to save the changes

​

Deleting a Pipeline Attribute

1. In the attributes table, locate the attribute you want to delete
2. In the Actions column, click the three dots icon (...)
3. In the dropdown menu, click Delete (trash icon in red)
4. Confirm the deletion in the dialog that appears

​

Form Fields in Detail

​

Apply to - Required

• Field: Apply to (marked with asterisk * indicating required field)
• Type: Dropdown (suspension menu)
• Description: Defines where the attribute will be applied
• Available Options:
  • Conversations: Attributes applied to conversations
  • Contacts: Attributes applied to contacts
  • Pipeline: Attributes applied to pipelines, stages, or items
• Help Text: Displays a description explaining the selected context
• Location: First field of the form

​

Pipeline Type - Required (only for Pipeline)

• Field: Pipeline Type (marked with asterisk * indicating required field)
• Type: Dropdown (suspension menu)
• Description: Defines whether the attribute applies to pipeline, stage, or item
• Available Options:
  • Pipeline: Attributes applied to the pipeline as a whole
  • Stage: Attributes applied to pipeline stages
  • Item: Attributes applied to pipeline items (deals/leads)
• Help Text: “Select whether this attribute applies to the pipeline, stage, or item.”
• Location: Second field of the form, displayed only when “Pipeline” is selected in “Apply to”

​

Display Name - Required

• Field: Display Name (marked with asterisk * indicating required field)
• Type: Simple text field
• Description: Friendly name that will be displayed to users
• Examples: “Lead Priority”, “Position”, “Contact Reason”
• Recommendation: Use descriptive and clear names that facilitate attribute identification
• Location: Third field of the form (or second, if not Pipeline)

​

Attribute Key - Required

• Field: Attribute Key (marked with asterisk * indicating required field)
• Type: Simple text field
• Description: Technical key used to identify the attribute in the API
• Help Text: “The key will be used to identify this attribute in the API. Use only lowercase letters, numbers and underscores.”
• Rules:
  • Use only lowercase letters, numbers, and underscores
  • Do not use spaces or special characters
  • Usually automatically generated from the Display Name
• Examples: lead_priority, position, contact_reason
• Location: Fourth field of the form (or third, if not Pipeline)

​

Description - Required

• Field: Description (marked with asterisk * indicating required field)
• Type: Text area (textarea)
• Description: Detailed explanation of the attribute’s purpose
• Examples:
  • “Define the priority of the opportunity in the sales pipeline.”
  • “Indicates the contact’s position or role within the company.”
  • “Identify the main reason why the customer contacted you.”
• Recommendation: Be clear and objective about what the attribute represents
• Location: Fifth field of the form (or fourth, if not Pipeline)

​

Type - Required

• Field: Type (marked with asterisk * indicating required field)
• Type: Dropdown (suspension menu)
• Description: Defines the data type that the attribute will accept
• Available Options:
  • Text: Simple text field
    • Description: “Simple text field”
    • Allows any free text
  • Number: Numeric field
  • Date: Date field
  • Boolean: True/false field
  • List: List of predefined values
• Help Text: Displays a description of the selected type
• Location: Sixth field of the form (or fifth, if not Pipeline)

​

Regex Validation - Optional

• Section: “Regex Validation”
• Description: “Add a regex pattern to validate the values of this attribute”
• Toggle Switch: Switch in the top right corner of the section
  • Deactivated: Regex validation will not be applied
  • Activated: Regex validation will be applied (indicated by green/turquoise color)

​

Regex Pattern

• Field: Regex Pattern
• Type: Simple text field
• Description: Regular expression that defines the validation pattern
• Examples:
  • ^(Low|Medium|High)$ - Accepts only “Low”, “Medium”, or “High”
  • ^.{2,}$ - Accepts any text with at least 2 characters
  • ^.{5,}$ - Accepts any text with at least 5 characters
• Recommendation: Test the regex pattern before saving to ensure it works as expected

​

Regex Cue

• Field: Regex Cue
• Type: Text area (textarea)
• Description: Help message displayed to users when they fill in the field
• Help Text: “This cue will be displayed to users when they fill in the field”
• Examples:
  • “Use only: Low, Medium or High”
  • “Please provide the contact’s job title (minimum 2 characters).”
  • “Describe the reason for contacting us (minimum 5 characters).”
• Recommendation: Be clear and specific about the expected format

​

Available Attribute Types

​

Text

• Description: Simple text field
• Usage: Allows entering any free text
• Usage examples:
  • Contact’s job position
  • Contact reason
  • General notes
• Validation: Can be combined with regex to restrict format or size

​

Number

• Description: Numeric field
• Usage: Allows entering numeric values
• Usage examples:
  • Estimated value of an opportunity
  • Number of company employees
  • Satisfaction score

​

Date

• Description: Date field
• Usage: Allows selecting or entering a date
• Usage examples:
  • Contact’s birthday
  • Expected opportunity closing date
  • Last contact date

​

Boolean

• Description: True/false field
• Usage: Allows marking as true or false
• Usage examples:
  • VIP customer (yes/no)
  • Accepts marketing (yes/no)
  • Qualified opportunity (yes/no)

​

List

• Description: List of predefined values
• Usage: Allows selecting a value from a predefined list
• Usage examples:
  • Priority (Low, Medium, High)
  • Status (Active, Inactive, Pending)
  • Lead source (Website, Referral, Campaign)

​

Regular Expression (Regex) Validation

​

When to Use Regex

• Predefined Values: When you want to restrict input to specific values (e.g., “Low”, “Medium”, “High”)
• Specific Format: When you need a specific format (e.g., product code, phone number)
• Minimum/Maximum Size: When you need to ensure a minimum or maximum text size
• Complex Patterns: When you need to validate more complex patterns (e.g., emails, URLs, codes)

​

Regex Pattern Examples

​

Predefined Values

^(Low|Medium|High)$

• Accepts only “Low”, “Medium”, or “High”
• Regex Cue: “Use only: Low, Medium or High”

​

Minimum Size

^.{2,}$

• Accepts any text with at least 2 characters
• Regex Cue: “Please provide at least 2 characters.”

^.{5,}$

• Accepts any text with at least 5 characters
• Regex Cue: “Describe the reason for contacting us (minimum 5 characters).”

​

Email Format

^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$

• Validates basic email format
• Regex Cue: “Please provide a valid email address.”

​

Tips for Regex

• Test First: Always test your regex pattern before saving to ensure it works as expected
• Be Specific: Use Regex Cue to clearly explain the expected format to users
• Documentation: Consider documenting complex regex patterns to facilitate future maintenance
• Performance: Very complex regex patterns can affect performance, use in moderation

​

Final Considerations

• Consistent Nomenclature: Use consistent display names and keys to facilitate organization and search
• Clear Descriptions: Write clear and objective descriptions that explain the purpose of each attribute
• Appropriate Validation: Use regex validation when necessary to ensure data quality, but don’t be overly restrictive
• Categorization: Organize attributes in appropriate categories (Conversations, Contacts, Pipeline) to facilitate management
• Regular Review: Periodically review existing attributes to ensure they remain relevant and updated
• Documentation: Document complex custom attributes or those with specific regex patterns to facilitate team use
• API Integration: Remember that the Attribute Key is used in the API - maintain consistency and avoid unnecessary changes
• Data Impact: Consider the impact on existing data before changing the Type or deleting an attribute
• Strategic Use: Use custom attributes to collect information that adds value to your business process