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

Tools

Slug: WHAUTOMATE_ADD_CONTACTTool to add a new contact. Use when you need to programmatically create contacts via the API.

Input Parameters

string
Unique identifier for the contact. If omitted, the server generates one.
string
required
Name of the contact.
array
Tags associated with the contact.
string
Additional notes about the contact.
string ("Subscriber" | "Engaged" | "Lead" | "Marketing qualified lead (MQL)" | "Sales qualified lead (SQL)" | "Opportunity" | "Follow-up Required" | "Customer" | "Evangelist" | "Other" | "Lost" | "Inactive")
Stage of the contact in the sales funnel.
object
required
Location details for the contact.
string
required
Phone number of the contact, including country code.
object
Custom fields for the contact.

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: WHAUTOMATE_DELETE_SEGMENTTool to delete a specific segment. Use when you need to remove a segment by its ID. Use after confirming you have the correct segmentId.

Input Parameters

string
required
Unique identifier of the segment 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: WHAUTOMATE_DELETE_SERVICE_CATEGORYTool 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.

Input Parameters

string
required
Unique identifier of the service category 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: WHAUTOMATE_GET_ACCOUNT_INFOTool to retrieve account information for the authenticated user. Use when you need to fetch account details like account name and owner email.

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: WHAUTOMATE_GET_ALL_WEBHOOKSRetrieve a page of registered webhooks for auditing or inspecting subscriptions, with optional pagination.

Input Parameters

integer
Page number to retrieve
integer
Maximum number of webhooks per page

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: WHAUTOMATE_GET_BROADCAST_BY_IDTool 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.

Input Parameters

string
required
Unique identifier of the broadcast to retrieve.

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: WHAUTOMATE_GET_BROADCASTSRetrieve a list of broadcasts with optional date, location and text filters and pagination.

Input Parameters

integer
Page number for pagination (starts from 1)
integer
Number of items per page (controls number of results returned)
string
Filter broadcasts up to this end date (ISO8601 format or date string)
string
Filter broadcasts from this start date (ISO8601 format or date string)
string
Filter broadcasts by location ID
string
Search broadcasts by text (name or content)

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: WHAUTOMATE_GET_CONTACTSRetrieve a list of contacts with optional pagination and filters, including communication channel.

Input Parameters

string
Page number for pagination
string
Filter contacts by associated tags
string
Maximum number of contacts per page
string
Filter contacts by communication channel
string
Filter contacts by specific location identifier
string
Search contacts by keyword or text matching (name, phone, etc.)

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: WHAUTOMATE_GET_MESSAGES_OF_CONTACTRetrieve chat messages for a specific Whautomate contact by contact ID. Supports pagination and optional start and end date parameters.

Input Parameters

integer
Page number for pagination (must be >=1)
string
ISO-8601 date to filter messages on or before this timestamp
string
required
Unique identifier of the contact to retrieve messages for
string
ISO-8601 date to filter messages on or after this timestamp

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: WHAUTOMATE_GET_SEGMENTSRetrieve Whautomate segments with optional name and location filters and pagination. Segments organize clients and contacts into groups based on criteria.

Input Parameters

integer
Page number for pagination (1-based)
integer
Number of items per page (pagination limit)
string
Filter segments by location ID
string
Filter segments by partial or full name match

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: WHAUTOMATE_GET_SERVICE_BY_IDRetrieve details of a specific Whautomate service by its unique ID.

Input Parameters

string
required
Unique identifier of the service to retrieve

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: WHAUTOMATE_GET_SERVICE_CATEGORIESRetrieve a list of Whautomate service categories, with optional limit and offset parameters for pagination.

Input Parameters

integer
Maximum number of records to return
integer
Number of records to skip for pagination

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: WHAUTOMATE_GET_SERVICESTool to retrieve a list of services with optional filters. Use when you need to fetch available services for display or scheduling.

Input Parameters

integer
Page number for pagination
integer
Maximum number of services to retrieve (1-100)
string
Filter services by a specific location ID
string
Search text to filter services by name
string
Filter services by type (e.g., ‘APPOINTMENT’)

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: WHAUTOMATE_GET_STAFF_AVAILABILITY_BLOCKSTool 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.

Input Parameters

string
End date (inclusive) in YYYY-MM-DD format
string
required
Unique identifier of the staff member
string
Start date (inclusive) in YYYY-MM-DD format

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: WHAUTOMATE_GET_STAFF_BY_IDTool 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.

Input Parameters

string
required
Unique identifier of the staff member to retrieve

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: WHAUTOMATE_GET_STAFFSTool to retrieve a list of staff members. Use when you need to list staff with optional pagination or search filters.

Input Parameters

integer
Page number of results to retrieve
integer
Number of records per page
string
Filter staff by location ID
string
Search keyword to filter staff by name or number

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: WHAUTOMATE_UPDATE_SERVICETool to update an existing Whautomate service. Use when you need to modify service attributes like name, pricing, duration, or active status.

Input Parameters

string
New name for the service.
boolean
Whether the service should be active (true) or inactive (false).
integer
Number of credits required for this service.
number
Cost price for the service.
string
required
Unique identifier of the service to update.
integer
Sort order for displaying the service.
number
Selling price for the service.
integer
Duration of the service in minutes.
boolean
Whether online booking is allowed for this service.
boolean
Whether online payment is accepted for this service.

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