Skip to main content
Landbot logo
  • Category: ai chatbots
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 13
  • Triggers: 0
  • Slug: LANDBOT
  • Version: 20261101_00

Tools

Slug: LANDBOT_DELETE_BOTTool to delete a specific bot from your account. Use when you need to remove an unused or test bot after confirming the bot ID.

Input Parameters

string
required
Unique identifier of the bot to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LANDBOT_GET_BRANDTool to retrieve your brand data including contact information and settings. Use when you need to access brand profile details, configuration, or contact information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LANDBOT_LIST_AGENTSList a page of agents in your Landbot account, with basic agent details and optional pagination.

Input Parameters

integer
Maximum number of records to return per request.
integer
Number of records to skip before returning results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LANDBOT_LIST_BOTSList a page of bots in your Landbot account, with optional pagination.

Input Parameters

integer
Maximum number of records to return per request.
integer
Number of records to skip before returning results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LANDBOT_LIST_CHANNELSList a page of messaging channels integrated with your account and their available metadata, with optional pagination.

Input Parameters

integer
Maximum number of records to return per request.
integer
Number of records to skip before returning results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LANDBOT_LIST_CUSTOMERSTool to list customers who have interacted with your bot. Use when you need to retrieve customer records with optional filters (channel_id, opt_in, search) and pagination.

Input Parameters

integer
Maximum number of records to return per request.
integer
Number of records to skip before returning results.
boolean
Filter only customers who have opted in (e.g., WhatsApp opt-in).
Value to search for in the specified field.
string ("phone" | "email" | "name")
Field to search by. Must be one of ‘phone’, ‘email’, or ‘name’.
integer
Filter by specific channel ID through which customers interact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LANDBOT_LIST_WHATSAPP_TEMPLATESTool to list all WhatsApp message templates available for the account. Use after obtaining your WhatsApp channel ID to fetch template IDs and parameter counts.

Input Parameters

integer
Optional WhatsApp channel ID to filter templates and avoid duplicates

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LANDBOT_REPLACE_AGENTUpdate a specific agent with a full PUT request, supplying first and last name and optionally password fields.

Input Parameters

string
required
The unique identifier of the agent to replace.
string
New password for the agent. Must be provided with password_confirmation if changing password.
string
required
Agent last name.
string
required
Agent first name.
string
Password confirmation. Required when changing password.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LANDBOT_REPLACE_BRANDTool to replace or update brand data with a full update (PUT operation). Use when you need to change company branding information in your Landbot account.

Input Parameters

string
Brand city name.
string
required
Brand name. This is the only required field for updating brand information.
string
Brand phone number. Include country code for international numbers.
string
Brand physical address or street address.
string
Brand country. Use ISO 3166-1 alpha-2 country codes (e.g., ‘US’, ‘GB’, ‘ES’).
string
Brand ZIP or postal code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LANDBOT_SEND_MESSAGESend a plain text outbound message to a Landbot customer by ID. Sending to an unassigned customer assigns them to the token’s agent; WhatsApp free-form messages are limited to the 24-hour window.

Input Parameters

string
required
Plain text message to send to the customer.
integer
required
Unique identifier of the customer to send the message to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LANDBOT_SET_AGENT_STATUSTool to change your agent status to online, offline, or busy. Use when you need to update your availability status in Landbot.

Input Parameters

string ("online" | "busy" | "offline")
required
New status for the agent. Must be one of: online, busy, or offline.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LANDBOT_UPDATE_AGENTTool to update an agent’s information in your Landbot account. Use when you need to modify agent details such as name, email, or password. This performs a partial update.

Input Parameters

string
Agent’s email address.
string
required
Unique identifier of the agent to update.
string
New password for the agent.
string
Agent’s last name.
string
Agent’s first name.
string
Password confirmation, required if password is provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LANDBOT_UPDATE_BRANDTool to partially update your brand data in Landbot. Use when you need to modify brand information such as name, phone, address, city, zipcode, or country.

Input Parameters

string
Brand city to update.
string
Brand name to update.
string
Brand phone number to update.
string
Brand address to update.
string
Brand country to update.
string
Brand zipcode to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not