Whautomate
whautomateWhautomate is a platform that offers seamless integrations for customer engagement, including AI chatbots, appointment scheduling, and broadcast messaging.
Acciones disponibles (16)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Add ContactWHAUTOMATE_ADD_CONTACTAcciónTool to add a new contact. use when you need to programmatically create contacts via the api.
WHAUTOMATE_ADD_CONTACTAcciónTool to add a new contact. use when you need to programmatically create contacts via the api.
Parámetros de entrada
idstringUnique identifier for the contact. If omitted, the server generates one.
namestringObligatorioName of the contact.
tagsstring[]Tags associated with the contact.
notesstringAdditional notes about the contact.
stagestringenumStage of the contact in the sales funnel.
SubscriberEngagedLeadMarketing qualified lead (MQL)Sales qualified lead (SQL)OpportunityFollow-up RequiredCustomerEvangelistOtherLostInactivelocationobjectObligatorioLocation details for the contact.
phoneNumberstringObligatorioPhone number of the contact, including country code.
customFieldsobjectCustom fields for the contact.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete SegmentWHAUTOMATE_DELETE_SEGMENTAcciónTool to delete a specific segment. use when you need to remove a segment by its id. use after confirming you have the correct segmentid.
WHAUTOMATE_DELETE_SEGMENTAcciónTool to delete a specific segment. use when you need to remove a segment by its id. use after confirming you have the correct segmentid.
Parámetros de entrada
segmentIdstringObligatorioUnique identifier of the segment to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Service CategoryWHAUTOMATE_DELETE_SERVICE_CATEGORYAcciónTool to delete a service category. use when you need to remove a specific service category by its id. use after confirming you have the correct servicecategoryid.
WHAUTOMATE_DELETE_SERVICE_CATEGORYAcciónTool to delete a service category. use when you need to remove a specific service category by its id. use after confirming you have the correct servicecategoryid.
Parámetros de entrada
serviceCategoryIdstringObligatorioUnique identifier of the service category to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get All WebhooksWHAUTOMATE_GET_ALL_WEBHOOKSAcciónTool to retrieve all registered webhooks. use after authenticating to audit or inspect existing webhook subscriptions.
WHAUTOMATE_GET_ALL_WEBHOOKSAcciónTool to retrieve all registered webhooks. use after authenticating to audit or inspect existing webhook subscriptions.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobject[]ObligatorioList of registered webhooks
errorstringError if any occurred during the execution of the action
statusstringObligatorioAPI status, e.g., 'success'
messagestringObligatorioAPI message or description of the result
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Broadcast By IDWHAUTOMATE_GET_BROADCAST_BY_IDAcciónTool to retrieve a specific broadcast's details. use when you have a broadcast id and need its metadata. use after confirming the broadcastid is valid, as this returns detailed broadcast data.
WHAUTOMATE_GET_BROADCAST_BY_IDAcciónTool to retrieve a specific broadcast's details. use when you have a broadcast id and need its metadata. use after confirming the broadcastid is valid, as this returns detailed broadcast data.
Parámetros de entrada
broadcastIdstringObligatorioUnique identifier of the broadcast to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get BroadcastsWHAUTOMATE_GET_BROADCASTSAcciónTool to retrieve a list of broadcasts. use when you need to fetch broadcasts with optional filters such as status or date ranges. example: "get all scheduled broadcasts after 2023-01-01t00:00:00z."
WHAUTOMATE_GET_BROADCASTSAcciónTool to retrieve a list of broadcasts. use when you need to fetch broadcasts with optional filters such as status or date ranges. example: "get all scheduled broadcasts after 2023-01-01t00:00:00z."
Parámetros de entrada
limitintegerNumber of items per page (default:10, max:50)
offsetintegerNumber of items to skip for pagination
statusstringenumFilter by broadcast status
scheduledin_progresscompletedto_datestringInclude broadcasts scheduled on or before this ISO8601 date
from_datestringInclude broadcasts scheduled on or after this ISO8601 date
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ContactsWHAUTOMATE_GET_CONTACTSAcciónTool to retrieve a list of contacts. use when you need to fetch contacts from whatsapp with optional pagination and filters.
WHAUTOMATE_GET_CONTACTSAcciónTool to retrieve a list of contacts. use when you need to fetch contacts from whatsapp with optional pagination and filters.
Parámetros de entrada
pageintegerPage number to retrieve (must be >=1)
limitintegerMaximum number of contacts per page
searchstringFilter contacts by name or phone
statusstringFilter contacts by WhatsApp status (e.g., "online", "offline")
Parámetros de salida
dataobject[]ObligatorioList of matching contacts
pageintegerObligatorioCurrent page number
errorstringError if any occurred during the execution of the action
limitintegerObligatorioMaximum number of contacts per page
totalintegerObligatorioTotal number of contacts matching the filter
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Messages of ContactWHAUTOMATE_GET_MESSAGES_OF_CONTACTAcciónTool to retrieve chat messages for a specific contact. use after providing a valid contactid. supports pagination and optional date filtering.
WHAUTOMATE_GET_MESSAGES_OF_CONTACTAcciónTool to retrieve chat messages for a specific contact. use after providing a valid contactid. supports pagination and optional date filtering.
Parámetros de entrada
pageintegerPage number for pagination (must be >=1)
endDatestringISO-8601 date to filter messages on or before this timestamp
contactIdstringObligatorioUnique identifier of the contact to retrieve messages for
startDatestringISO-8601 date to filter messages on or after this timestamp
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SegmentsWHAUTOMATE_GET_SEGMENTSAcciónTool to retrieve a list of segments. use when you need to fetch segments with optional name filtering and pagination.
WHAUTOMATE_GET_SEGMENTSAcciónTool to retrieve a list of segments. use when you need to fetch segments with optional name filtering and pagination.
Parámetros de entrada
namestringFilter segments by partial or full name match
limitintegerNumber of items per page (pagination limit)
offsetintegerNumber of items to skip for pagination
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Service By IdWHAUTOMATE_GET_SERVICE_BY_IDAcciónTool to retrieve details of a specific service by its unique id. use when you need comprehensive service information.
WHAUTOMATE_GET_SERVICE_BY_IDAcciónTool to retrieve details of a specific service by its unique id. use when you need comprehensive service information.
Parámetros de entrada
serviceIdstringObligatorioUnique identifier of the service to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Service CategoriesWHAUTOMATE_GET_SERVICE_CATEGORIESAcciónTool to retrieve a list of service categories. use when you need to list categories with optional pagination.
WHAUTOMATE_GET_SERVICE_CATEGORIESAcciónTool to retrieve a list of service categories. use when you need to list categories with optional pagination.
Parámetros de entrada
limitintegerMaximum number of records to return
offsetintegerNumber of records to skip for pagination
Parámetros de salida
dataobject[]ObligatorioList of retrieved service categories
errorstringError if any occurred during the execution of the action
limitintegerObligatorioLimit applied in the request
totalintegerObligatorioTotal number of service categories available
offsetintegerObligatorioOffset applied in the request
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ServicesWHAUTOMATE_GET_SERVICESAcciónTool to retrieve a list of services with optional filters. use when you need to fetch available services for display or scheduling.
WHAUTOMATE_GET_SERVICESAcciónTool to retrieve a list of services with optional filters. use when you need to fetch available services for display or scheduling.
Parámetros de entrada
sortstringField to sort by, prefix with '-' for descending (e.g., 'name', '-duration')
limitintegerMaximum number of services to retrieve (1-100)
fieldsstringComma-separated list of service fields to include (e.g., 'id,name,duration')
offsetintegerNumber of services to skip for pagination
category_idstringFilter services by a specific category ID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Staff Availability BlocksWHAUTOMATE_GET_STAFF_AVAILABILITY_BLOCKSAcciónTool to retrieve a staff member's blocked time schedule over a date range. use when you need to view unavailable slots after confirming staffid and desired date range.
WHAUTOMATE_GET_STAFF_AVAILABILITY_BLOCKSAcciónTool to retrieve a staff member's blocked time schedule over a date range. use when you need to view unavailable slots after confirming staffid and desired date range.
Parámetros de entrada
endDatestringEnd date (inclusive) in YYYY-MM-DD format
staffIdstringObligatorioUnique identifier of the staff member
startDatestringStart date (inclusive) in YYYY-MM-DD format
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Staff By IDWHAUTOMATE_GET_STAFF_BY_IDAcciónTool to retrieve detailed information about a specific staff member. use when you have a valid staff id and need full profile details. use after confirming staffid.
WHAUTOMATE_GET_STAFF_BY_IDAcciónTool to retrieve detailed information about a specific staff member. use when you have a valid staff id and need full profile details. use after confirming staffid.
Parámetros de entrada
staffIdstringObligatorioUnique identifier of the staff member to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get StaffsWHAUTOMATE_GET_STAFFSAcciónTool to retrieve a list of staff members. use when you need to list staff with optional pagination or search filters.
WHAUTOMATE_GET_STAFFSAcciónTool to retrieve a list of staff members. use when you need to list staff with optional pagination or search filters.
Parámetros de entrada
pageintegerPage number of results to retrieve
limitintegerNumber of records per page
searchstringSearch keyword to filter staff by name or number
Parámetros de salida
dataobject[]ObligatorioList of staff members
metaobjectObligatorioPagination metadata
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update ServiceWHAUTOMATE_UPDATE_SERVICEAcciónTool to update an existing whatsapp service. use when you need to modify service attributes like name, description, enabled state, or config.
WHAUTOMATE_UPDATE_SERVICEAcciónTool to update an existing whatsapp service. use when you need to modify service attributes like name, description, enabled state, or config.
Parámetros de entrada
namestringNew name for the service.
configobjectKey-value configuration settings for the service.
enabledbooleanWhether the service should be enabled (true) or disabled (false).
serviceIdstringObligatorioUnique identifier of the service to update.
descriptionstringUpdated description for the service.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not