Variables

A variable in Luella is a placeholder that can be inserted into an outreach sequence copy to take on a value specific to a contact that the email is being sent to during dispatch time. For example, a first_name variable would be replaced with the actual contact's first name when the message is sent. Variables allow dynamic content injection for personalization.

The variable model

The variable model represents a user-defined tag used to personalize outreach copy. Variables include a name, an optional description, and are evaluated at the time of email dispatch.

Properties

Name
variableId
Type
string
Description
Unique identifier for the variable.
Name
workspaceId
Type
string
Description
Identifier of the workspace the variable belongs to.
Name
name
Type
string
Description
Name of the variable. Will be referenced in outreach content like .
Name
description
Type
string
Description
Optional description of what the variable represents.

POST/variables/ListVariables

List all variables

This endpoint allows you to retrieve all variables created under a workspace. Variables define custom dynamic fields used during email personalization.

Required attributes

Name
userId
Type
string
Description
ID of the user making the request.
Name
workspaceId
Type
string
Description
ID of the workspace whose variables should be returned.

Optional attributes

Name
maxItems
Type
integer
Description
Number of variables to return per page.
Name
nextToken
Type
string
Description
Pagination token to retrieve next page of variables.
Name
sortOrder
Type
'Ascending' | 'Descending'
Description
Optional sort order (e.g., Ascending or Descending).

Request

POST

/variables/ListVariables

{
  "userId": "user_123",
  "workspaceId": "workspace_456",
  "maxItems": 10
}

Response

{
  "variables": [
    {
      "variableId": "var_001",
      "name": "first_name",
      "description": "The contact's first name"
    }
  ],
  "nextToken": null
}

POST/variables/CreateVariable

Create a new variable

Create a new personalization variable for use in your sequence copy.

Required attributes

Name
userId
Type
string
Description
ID of the user creating the variable.
Name
workspaceId
Type
string
Description
Workspace in which the variable is being defined.
Name
variableName
Type
string
Description
The name of the variable.

Optional attributes

Name
variableDescription
Type
string
Description
Optional description of the variable.

Request

POST

/variables/CreateVariable

{
  "userId": "user_123",
  "workspaceId": "workspace_456",
  "variableName": "first_name",
  "variableDescription": "The contact's first name"
}

Response

{
  "variableId": "var_001"
}

POST/variables/UpdateVariable

Update a variable

Update an existing variable with a new name or description.

Required attributes

Name
userId
Type
string
Description
User requesting the update.
Name
workspaceId
Type
string
Description
Workspace the variable belongs to.
Name
variableId
Type
string
Description
Unique identifier of the variable to update.
Name
variableName
Type
string
Description
New name for the variable.

Optional attributes

Name
variableDescription
Type
string
Description
Updated description of the variable.

Request

POST

/variables/UpdateVariable

{
  "userId": "user_123",
  "workspaceId": "workspace_456",
  "variableId": "var_001",
  "variableName": "first_name",
  "variableDescription": "Updated description"
}

Response

{
  "variableId": "var_001"
}

POST/variables/DeleteVariable

Delete a variable

Permanently delete a variable from your workspace.

Required attributes

Name
userId
Type
string
Description
The user making the deletion request.
Name
workspaceId
Type
string
Description
Workspace from which the variable should be removed.
Name
variableId
Type
string
Description
Unique identifier for the variable to be deleted.

Request

POST

/variables/DeleteVariable

{
  "userId": "user_123",
  "workspaceId": "workspace_456",
  "variableId": "var_001"
}

Response

{}