> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Whautomate

> Whautomate is a platform that offers seamless integrations for customer engagement, including AI chatbots, appointment scheduling, and broadcast messaging.

![Whautomate logo](https://mintcdn.com/composio-preview/DMB8UrgJmE7r-ZQ5/images/toolkits/whautomate.svg?fit=max\&auto=format\&n=DMB8UrgJmE7r-ZQ5\&q=85\&s=3f5b1fb882fe0cdb413bc61a1e7e5b31)

* **Category:** ai chatbots
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 17
* **Triggers:** 0
* **Slug:** `WHAUTOMATE`
* **Version:** 20261101\_00

## Tools

> [accordion] Add Contact
>
> **Slug:** `WHAUTOMATE_ADD_CONTACT`
>
> Tool to add a new contact. Use when you need to programmatically create contacts via the API.
>
> #### Input Parameters
>
> **id** `string`
>
> Unique identifier for the contact. If omitted, the server generates one.
>
> **name** `string` *required*
>
> Name of the contact.
>
> **tags** `array`
>
> Tags associated with the contact.
>
> **notes** `string`
>
> Additional notes about the contact.
>
> **stage** `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.
>
> **location** `object` *required*
>
> Location details for the contact.
>
> **phoneNumber** `string` *required*
>
> Phone number of the contact, including country code.
>
> **customFields** `object`
>
> Custom fields for the contact.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Segment
>
> **Slug:** `WHAUTOMATE_DELETE_SEGMENT`
>
> Tool 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
>
> **segmentId** `string` *required*
>
> Unique identifier of the segment to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Service Category
>
> **Slug:** `WHAUTOMATE_DELETE_SERVICE_CATEGORY`
>
> Tool 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
>
> **serviceCategoryId** `string` *required*
>
> Unique identifier of the service category to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Account Info
>
> **Slug:** `WHAUTOMATE_GET_ACCOUNT_INFO`
>
> Tool to retrieve account information for the authenticated user. Use when you need to fetch account details like account name and owner email.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get All Webhooks
>
> **Slug:** `WHAUTOMATE_GET_ALL_WEBHOOKS`
>
> Retrieve a page of registered webhooks for auditing or inspecting subscriptions, with optional pagination.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to retrieve
>
> **limit** `integer`
>
> Maximum number of webhooks per page
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Broadcast By ID
>
> **Slug:** `WHAUTOMATE_GET_BROADCAST_BY_ID`
>
> Tool 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
>
> **broadcastId** `string` *required*
>
> Unique identifier of the broadcast to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Broadcasts
>
> **Slug:** `WHAUTOMATE_GET_BROADCASTS`
>
> Retrieve a list of broadcasts with optional date, location and text filters and pagination.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination (starts from 1)
>
> **limit** `integer`
>
> Number of items per page (controls number of results returned)
>
> **endDate** `string`
>
> Filter broadcasts up to this end date (ISO8601 format or date string)
>
> **startDate** `string`
>
> Filter broadcasts from this start date (ISO8601 format or date string)
>
> **locationId** `string`
>
> Filter broadcasts by location ID
>
> **searchText** `string`
>
> Search broadcasts by text (name or content)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Contacts
>
> **Slug:** `WHAUTOMATE_GET_CONTACTS`
>
> Retrieve a list of contacts with optional pagination and filters, including communication channel.
>
> #### Input Parameters
>
> **page** `string`
>
> Page number for pagination
>
> **tags** `string`
>
> Filter contacts by associated tags
>
> **limit** `string`
>
> Maximum number of contacts per page
>
> **channel** `string`
>
> Filter contacts by communication channel
>
> **locationId** `string`
>
> Filter contacts by specific location identifier
>
> **searchText** `string`
>
> Search contacts by keyword or text matching (name, phone, etc.)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Messages of Contact
>
> **Slug:** `WHAUTOMATE_GET_MESSAGES_OF_CONTACT`
>
> Retrieve chat messages for a specific Whautomate contact by contact ID. Supports pagination and optional start and end date parameters.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination (must be >=1)
>
> **endDate** `string`
>
> ISO-8601 date to filter messages on or before this timestamp
>
> **contactId** `string` *required*
>
> Unique identifier of the contact to retrieve messages for
>
> **startDate** `string`
>
> ISO-8601 date to filter messages on or after this timestamp
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Segments
>
> **Slug:** `WHAUTOMATE_GET_SEGMENTS`
>
> Retrieve Whautomate segments with optional name and location filters and pagination. Segments organize clients and contacts into groups based on criteria.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination (1-based)
>
> **limit** `integer`
>
> Number of items per page (pagination limit)
>
> **locationId** `string`
>
> Filter segments by location ID
>
> **searchText** `string`
>
> Filter segments by partial or full name match
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Service By Id
>
> **Slug:** `WHAUTOMATE_GET_SERVICE_BY_ID`
>
> Retrieve details of a specific Whautomate service by its unique ID.
>
> #### Input Parameters
>
> **serviceId** `string` *required*
>
> Unique identifier of the service to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Service Categories
>
> **Slug:** `WHAUTOMATE_GET_SERVICE_CATEGORIES`
>
> Retrieve a list of Whautomate service categories, with optional limit and offset parameters for pagination.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of records to return
>
> **offset** `integer`
>
> Number of records to skip for pagination
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Services
>
> **Slug:** `WHAUTOMATE_GET_SERVICES`
>
> Tool to retrieve a list of services with optional filters. Use when you need to fetch available services for display or scheduling.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination
>
> **limit** `integer`
>
> Maximum number of services to retrieve (1-100)
>
> **locationId** `string`
>
> Filter services by a specific location ID
>
> **searchText** `string`
>
> Search text to filter services by name
>
> **serviceType** `string`
>
> Filter services by type (e.g., 'APPOINTMENT')
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Staff Availability Blocks
>
> **Slug:** `WHAUTOMATE_GET_STAFF_AVAILABILITY_BLOCKS`
>
> Tool 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
>
> **endDate** `string`
>
> End date (inclusive) in YYYY-MM-DD format
>
> **staffId** `string` *required*
>
> Unique identifier of the staff member
>
> **startDate** `string`
>
> Start date (inclusive) in YYYY-MM-DD format
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Staff By ID
>
> **Slug:** `WHAUTOMATE_GET_STAFF_BY_ID`
>
> Tool 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
>
> **staffId** `string` *required*
>
> Unique identifier of the staff member to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Staffs
>
> **Slug:** `WHAUTOMATE_GET_STAFFS`
>
> Tool to retrieve a list of staff members. Use when you need to list staff with optional pagination or search filters.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number of results to retrieve
>
> **limit** `integer`
>
> Number of records per page
>
> **locationId** `string`
>
> Filter staff by location ID
>
> **searchText** `string`
>
> Search keyword to filter staff by name or number
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Service
>
> **Slug:** `WHAUTOMATE_UPDATE_SERVICE`
>
> Tool to update an existing Whautomate service. Use when you need to modify service attributes like name, pricing, duration, or active status.
>
> #### Input Parameters
>
> **name** `string`
>
> New name for the service.
>
> **active** `boolean`
>
> Whether the service should be active (true) or inactive (false).
>
> **credits** `integer`
>
> Number of credits required for this service.
>
> **costPrice** `number`
>
> Cost price for the service.
>
> **serviceId** `string` *required*
>
> Unique identifier of the service to update.
>
> **sortOrder** `integer`
>
> Sort order for displaying the service.
>
> **sellingPrice** `number`
>
> Selling price for the service.
>
> **durationMinutes** `integer`
>
> Duration of the service in minutes.
>
> **allowOnlineBooking** `boolean`
>
> Whether online booking is allowed for this service.
>
> **acceptPaymentOnline** `boolean`
>
> Whether online payment is accepted for this service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
