← Tools Reference

Landbot

Landbot integration (Communication, Marketing). Imported from open-connector.

API key5 toolshttps://api.landbot.io/v1
GET
landbot_list_channels
List channels in a Landbot workspace with optional pagination and filters.

/channels/

4 parameters
ParamTypeRequiredDescription
offsetintegeroptionalNumber of items to skip before returning this page.
limitintegeroptionalMaximum number of items to return in this page. Landbot accepts up to 100.
typestringoptionalFilter channels by Landbot channel type, such as webchat or whatsapp.
activebooleanoptionalFilter channels by active state.
GET
landbot_list_customers
List Landbot customers with pagination and optional channel or search filters.

/customers/

8 parameters
ParamTypeRequiredDescription
offsetintegeroptionalNumber of items to skip before returning this page.
limitintegeroptionalMaximum number of items to return in this page. Landbot accepts up to 100.
channel_idintegeroptionalFilter customers by numeric Landbot channel id.
agent_idintegeroptionalFilter customers by numeric Landbot agent id.
archivedbooleanoptionalFilter customers by archived state.
opt_inbooleanoptionalFilter customers by opt-in state.
search_bystringoptionalCustomer field used for search.
searchstringoptionalSearch text matched against the selected customer field.
GET
landbot_get_customer_messages
Fetch the message history for a Landbot customer.

/customers/{readCustomerId}/messages/

2 parameters
ParamTypeRequiredDescription
customer_idintegeroptionalNumeric Landbot customer id.
readCustomerIdstringrequiredPath parameter: readCustomerId
POST
landbot_send_text
Send a text message to a Landbot customer through their current channel.

/customers/{readCustomerId}/send_text/

3 parameters
ParamTypeRequiredDescription
customer_idintegeroptionalNumeric Landbot customer id.
messagestringoptionalText message to send to the customer.
readCustomerIdstringrequiredPath parameter: readCustomerId
POST
landbot_set_customer_field
Set a typed custom field value on a Landbot customer.

/customers/{readCustomerId}/fields/{field_name}/

6 parameters
ParamTypeRequiredDescription
customer_idintegerrequiredNumeric Landbot customer id.
field_namestringrequiredLandbot field name to set on the customer.
typestringrequiredLandbot field type for the value.
valuestringrequiredValue to store in the Landbot customer field.
extraobjectoptionalOptional extra metadata passed through to Landbot for the field.
readCustomerIdstringrequiredPath parameter: readCustomerId