Variables

​

Introduction

• User Inputs: Data collected from user responses (e.g., names, email addresses).
• System Data: Information retrieved from external sources like CRM systems.
• Computed Values: Results from expressions or calculations within the conversation flow.

​

Variable Manager Overview

​

Accessing the Variable Manager

1

From the Header

You can access the Variable Manager directly from the top navigation bar of the Flow Editor.

2

From a Text Field

You can also access the Variable Manager from a text field whenever the + icon is available.

Only fields that support variables will display the “+” icon.
For example, some duration or static option fields won’t offer variable insertion.

• Open a Node in the Flow Editor.
• Click the “+” icon inside the supported text input field.
• At the bottom of the dropdown, click “Variable Manager”.

​

Creating and Managing Variables

1

Open the Variable Manager

Click the “+” icon in a text field or use the Variable Manager button (in the header or Flow Editor).

2

Select the Variable Category

• Pre-call (available before the call starts)
• Collected In-call (captured during the conversation)

Post-call variables are predefined by our team and cannot be created manually. They are only available inside Post-Call Actions.

Some variables are system-defined and read-only (shown at the top of the list), you can use them but not edit or delete them. Examples: Pre-call — agent name, first name, last name, phone number, email address, call id; Post-call — summary, transcript, recording, duration, call time.

3

Fill in the Variable Details

Field	Description	Rules
Type	The variable’s data type (see the Variable Types table below).	Required
Display Name	Human-readable label shown in the UI and used by Pearl (e.g. Customer Name).	Required · max 40 chars · letters, numbers, spaces
ID	Unique system key used to reference the variable in flows, CSV imports, and API payloads. Auto-generated from the Display Name, editable.	Required · unique · max 40 chars · letters, numbers, _, - · no spaces
Description (optional)	Explain the purpose or usage of this variable (helps Pearl use it correctly).	Optional · max 300 chars
Allow Multiple Entries	Store a list of values of the chosen type (e.g. several dates).	Optional

Display Name vs ID — the Display Name is what you read and what Pearl says; the ID is the key the system uses everywhere else. When importing leads via CSV or the API, the column header / callData key must match the variable’s ID, not its Display Name.

Variable Types

Type	Example
Text	a name, a plan
Whole Number	age, quantity
Decimal Number	an amount, a rate
Boolean	true / false
Date	a birth date
Time	an appointment time
Date & Time	a meeting slot

4

Define Allowed Values (Optional)

Use this section to limit inputs to specific options.

• Add a list of accepted values.
• Optionally assign backend codes to each value.
• Toggle Allow Multiple Entries if more than one value can be selected.

This is ideal for dropdowns or structured inputs (e.g. Issue Type, Region, etc.).

5

Save the Variable

It will now be available anywhere in your flow where variables are supported.

6

Use your variables wherever applicable

Some fields, like the Opening Sentence, do not support the use of in-call variables.When testing your flows via Test Calls, note that Pre-call variables are required, while In-call variables are optional.Also, when uploading a lead file, only the variables you’ve actually used in your flows will appear in the platform’s lead mapping interface.In other words:
If you’ve created variables in the Variable Manager but haven’t used them anywhere, they won’t show up when setting up an outbound campaign or importing leads.

Search, Edit or Delete a VariableTo search a variable:

• Open the Variable Manager.
• Click on the search bar.

To edit a variable:

• Open the Variable Manager.
• Click on the variable name to open its edit form.

To delete a variable:

• Click the Trash icon next to the variable.
• Confirm the deletion in the dialog box.

Deleting a variable will remove it from all flows where it’s used. Proceed with caution!

​

Using Variables in Conversations

1. Compose the Agent’s Script in any text field within your flow.
2. Insert Variable Placeholder:
   • Click the ”+” icon next to the text field.
   • Select the desired variable from the list.

1. Add an Action Node (e.g., Email Node, SMS Node) to your flow.
2. Configure the Action:
   • Message Content: Include variables by clicking the ”+” icon and selecting the desired variable.
3. Customize the Message with variable placeholders.

1. Add a Post-Call Action to your flow (SMS, Email, API).
2. Write the Notification Message, using the “+” icon to insert dynamic variables
3. Customize the content to provide a clear summary of each completed call.

​

Implementing Conditional Logic with Variables

1. Enable Conditional Transitions in a node’s configuration by toggling the “Conditional Branching” option.
2. Add Conditions using variables and operators (e.g., satisfactionScore >= 4).
3. Label Each Condition for clarity.
4. Connect to Subsequent Nodes based on each condition.

​

Populating Variables from External Data

1

Download the Lead Template CSV

Go to the Outbound Campaigns section of the platform, then click Download Lead Template.This CSV contains predefined columns where you can add your custom variables.

2

Fill in the CSV with your Lead Data

Open the downloaded CSV and complete it by filling in the lead information, including any custom variables in the appropriate columns.Make sure each variable matches the column header to avoid upload issues.Once completed, upload the CSV back into the platform.

1. Use the Add Lead API Endpoint: PUT /v1/Outbound/{outboundId}/Lead.
2. Include Variables in the callData field of your JSON payload.

PUT /v1/Outbound/{outboundId}/Lead
Content-Type: application/json
Authorization: Bearer <token>

{
  "phoneNumber": "+1234567890",
  "externalId": "lead123",
  "callData": {
    "customerName": "Jane Smith",
    "membershipStatus": "Gold"
  }
}

1. Use the Make Call API Endpoint: POST /v1/Outbound/{outboundId}/Call.
2. Include Variables in the callData field of your JSON payload.

POST /v1/Outbound/{outboundId}/Call
Content-Type: application/json
Authorization: Bearer <token>

{
  "to": "+1234567890",
  "callData": {
    "firstName": "John",
    "accountBalance": "$100"
  }
}

​

Examples

​

Frequently Asked Questions (FAQ)

​

Conclusion

• Collect and Store User Inputs: Gather essential information from users.
• Personalize Interactions: Create tailored experiences for each user.
• Control Conversation Flow: Direct the conversation based on user responses and data.
• Integrate External Data: Incorporate information from other systems for enriched interactions.