> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to 2Chat

The 2Chat connector lets your AI agent act in each user's 2Chat account. Each user connects their own 2Chat API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.

**Authentication:** API Key
**Categories:** Communication, Customer Support
**Tools:** 60: 34 read, 20 write, 6 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=TWOCHAT)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the 2Chat connection

   In **AgentKit > Connections**, create a 2Chat connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'twochat'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize 2Chat:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'twochat_call_history_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "twochat"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize 2Chat:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="twochat_call_history_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their 2Chat credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'twochat_call_get',
  toolInput: {
    call_uuid: '<call_uuid>',
  },
  connector: 'twochat',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="twochat_call_get",
    tool_input={
        "call_uuid": "<call_uuid>",
    },
    connection_name="twochat",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `twochat_call_get`

Get Call Details · Read-only

Get the full details of one phone call.
Returns call metadata, cost breakdown and agent information.
Use twochat_call_history_list to find call UUIDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `call_uuid` (`string`, required): Call record UUID (starts with CDR). Example: CDR8b3e7a1f-6c94-4d52-ae17-5f2b9d4c8e63.

Example input: `{"call_uuid":"<call_uuid>"}`

### `twochat_call_history_list`

List Call History · Read-only

List the phone calls made or received through your 2Chat virtual numbers.
Returns call records with uuid, direction, numbers, duration, status and cost.
Use twochat_call_get for one call's full details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `direction` (`string`, optional): Only inbound or outbound calls. Any direction when empty. Example: outbound. One of: `inbound`, `outbound`.
- `from_number` (`string`, optional): Inbound calls: only calls from this number. Example: +12124557899.
- `page_number` (`integer`, optional): Page number to return. Example: 0.
- `to_number` (`string`, optional): Outbound calls: only calls to this number. Example: +12124557899.

Example input: `{}`

### `twochat_call_price_get`

Get Call Price · Read-only

Get the estimated per-minute price of calling a phone number.
Returns the destination and price per minute.
Use this before placing calls to a new country.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `phone_number` (`string`, required): Destination phone number in international format. Example: +595984153762.

Example input: `{"phone_number":"<phone_number>"}`

### `twochat_contact_get`

Get Contact · Read-only

Get one 2Chat contact by UUID.
Returns the contact's uuid, first_name, last_name, channel_uuid, profile_pic_url and last_updated.
Use twochat_contacts_search or twochat_contacts_list to find UUIDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `contact_uuid` (`string`, required): Contact UUID (starts with CON), from twochat_contacts_list or twochat_contacts_search. Example: CON58147f7c-3756-4ca1-893c-c3360342b424.

Example input: `{"contact_uuid":"<contact_uuid>"}`

### `twochat_contacts_list`

List Contacts · Read-only

List the contacts in your 2Chat account, page by page.
Returns contacts with uuid, first_name, last_name, channel_uuid, profile_pic_url and details (phones, emails, addresses).
Use this to browse. Use twochat_contacts_search to find a contact by name or number.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `channel_uuid` (`string`, optional): Only contacts linked to this connected number (WPN...). Example: WPN66037eca-9ad1-4c96-9eff-526a90a48c77.
- `page_number` (`integer`, optional): Page number to return, starting at 0. Example: 0.
- `results_per_page` (`integer`, optional): Contacts per page, from 1 to 100. Example: 20.

Example input: `{}`

### `twochat_contacts_search`

Search Contacts · Read-only

Search your 2Chat contacts by name or phone number.
Returns matching contacts with uuid, names, channel_uuid, last_updated and details.
Use this to find a contact's UUID. Use twochat_conversations_search to search message text.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `query` (`string`, required): Name or phone digits to look for, such as Kate Smith or 5550147. Example: Kate.
- `channel_uuid` (`string`, optional): Only contacts linked to this connected number (WPN...). Example: WPN66037eca-9ad1-4c96-9eff-526a90a48c77.
- `page_number` (`integer`, optional): Zero-based page number. Defaults to 0. Example: 0.
- `results_per_page` (`integer`, optional): Contacts per page, from 1 to 50. Defaults to 10. Example: 20.

Example input: `{"query":"<query>"}`

### `twochat_conversation_assignment_get`

Get Conversation Assignment · Read-only

Get the user and the team a conversation is assigned to.
Returns the assigned user and team, or null for each when unassigned.
Use this before reassigning.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `session_key` (`string`, required): The conversation's session_key, from twochat_conversations_search, twochat_whatsapp_conversations_list or a message. Example: WA-WAN8fd3442f-e111-4fed-9323-1824fd7546c9-14085550176.

Example input: `{"session_key":"<session_key>"}`

### `twochat_conversation_tags_get`

Get Conversation Tags · Read-only

Get the tags a conversation has now, including ones added in the live chat or by flows.
Returns the conversation's tags with uuid, name and color.
Use twochat_conversation_tag_add or twochat_conversation_tag_remove to change them.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `session_key` (`string`, required): The conversation's session_key, from twochat_conversations_search, twochat_whatsapp_conversations_list or a message. Example: WA-WAN8fd3442f-e111-4fed-9323-1824fd7546c9-14085550176.

Example input: `{"session_key":"<session_key>"}`

### `twochat_conversations_search`

Search Conversations · Read-only

Search all conversations by contact name, phone number and message text, as the live chat search does.
Returns contacts (matching conversations) and messages (matching messages, newest first, with highlights), each with its session_key.
Use this to find a session_key for the conversation tools.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `q` (`string`, required): Search term of at least 2 characters. Example: invoice.
- `contacts_limit` (`integer`, optional): Maximum contact matches, from 1 to 50. Defaults to 20. Example: 20.
- `page_number` (`integer`, optional): Zero-based page of the messages group. Defaults to 0. Example: 0.
- `results_per_page` (`integer`, optional): Messages per page, from 1 to 100. Defaults to 20. Example: 20.

Example input: `{"q":"<q>"}`

### `twochat_scheduled_messages_list`

List Scheduled Messages · Read-only

List the scheduled WhatsApp messages still waiting to be sent, across all numbers.
Returns pending scheduled messages with uuid, numbers, text, next send time and recurrence.
Use this to find a uuid to cancel or send now.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `twochat_sms_channels_list`

List SMS Channels · Read-only

List the SMS numbers connected to your 2Chat account.
Returns channels with uuid (SMS...), phone number and status.
Use this to get a channel UUID for the SMS conversation tools.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page_number` (`integer`, optional): Zero-based page number. Defaults to 0. Example: 0.
- `results_per_page` (`integer`, optional): Channels per page, from 1 to 200. Defaults to 200. Example: 20.

Example input: `{}`

### `twochat_sms_conversations_list`

List SMS Conversations · Read-only

List the conversations on an SMS channel, one per contact with its latest message, newest first.
Returns contacts with their latest message.
Use twochat_sms_messages_list for a full thread.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `channel_uuid` (`string`, required): UUID of the SMS channel (starts with SMS), from twochat_sms_channels_list. Example: SMS9a3f1c20-4e7b-4d8a-9c61-2f5b8d0a4e13.
- `page_number` (`integer`, optional): Zero-based page number. Defaults to 0. Example: 0.
- `results_per_page` (`integer`, optional): Conversations per page, from 1 to 200. Defaults to 20. Example: 20.

Example input: `{"channel_uuid":"<channel_uuid>"}`

### `twochat_sms_message_get`

Get SMS Message · Read-only

Get one SMS message by UUID (inbound starts with SMI, outbound with SMO).
Returns the message's direction, numbers, text, status and timestamps.
Use twochat_sms_messages_list to find UUIDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `message_uuid` (`string`, required): SMS message UUID. Example: SMI4f2a1c33-7b6e-4d9a-8c12-9f0e1a2b3c4d.

Example input: `{"message_uuid":"<message_uuid>"}`

### `twochat_sms_messages_list`

List SMS Messages · Read-only

Get the SMS thread between an SMS channel and a contact, inbound and outbound, oldest to newest.
Returns messages with uuid, direction, text and timestamps.
Pass the earliest timestamp as before_ts to page back in time.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `channel_uuid` (`string`, required): UUID of the SMS channel (starts with SMS), from twochat_sms_channels_list. Example: SMS9a3f1c20-4e7b-4d8a-9c61-2f5b8d0a4e13.
- `contact_number` (`string`, required): The contact's phone number in international format. Example: +447700900123.
- `before_ts` (`integer`, optional): Unix timestamp in seconds: only messages older than this. Example: 1718790043.
- `results_per_page` (`integer`, optional): Messages to return, from 1 to 200. Defaults to 50. Example: 20.

Example input: `{"channel_uuid":"<channel_uuid>","contact_number":"<contact_number>"}`

### `twochat_tags_list`

List Tags · Read-only

List the conversation tags of your 2Chat account, sorted by name.
Returns tags with uuid, name and color.
Use this to get a tag_uuid. Use twochat_conversation_tags_get for one conversation's tags.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Zero-based page. Defaults to 0. Example: 0.
- `page_size` (`integer`, optional): Tags per page, from 1 to 50. Defaults to 10. Example: 20.

Example input: `{}`

### `twochat_teams_list`

List Account Teams · Read-only

List the teams of your 2Chat account.
Returns each team's uuid and name.
Use this to get a team_uuid for twochat_conversation_assign_team.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `twochat_users_list`

List Account Users · Read-only

List the active users of your 2Chat account.
Returns each user's uuid, first_name, last_name and email.
Use this to get a user_uuid for twochat_conversation_assign_user or note mentions.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `twochat_waba_conversation_messages_list`

List WABA Conversation Messages · Read-only

List the messages between your WABA number and one contact, newest first.
Returns messages with uuid, direction, text, template, status and timestamps, plus has_more.
Keep paging while has_more is true.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `from_number` (`string`, required): Your WABA number in international format. Example: +15550001111.
- `to_number` (`string`, required): The contact's number in international format. Example: +5215512345432.
- `include_error` (`boolean`, optional): Set true to add each message's last delivery status and failure reason. Example: false.
- `page_number` (`integer`, optional): Zero-based page number. Defaults to 0. Example: 0.
- `results_per_page` (`integer`, optional): Messages per page, from 1 to 200. Defaults to 50. Example: 20.

Example input: `{"from_number":"<from_number>","to_number":"<to_number>"}`

### `twochat_waba_conversation_window_get`

Check WABA Conversation Window · Read-only

Check whether the 24-hour customer service window is open between your WABA number and a contact.
Returns whether the window is open and when it closes.
Use this to decide between free-form text and a template in twochat_waba_message_send.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `from_number` (`string`, required): Your WABA number in international format. Example: +15550001111.
- `to_number` (`string`, required): The contact's number in international format. Example: +15552223333.

Example input: `{"from_number":"<from_number>","to_number":"<to_number>"}`

### `twochat_waba_conversations_list`

List WABA Conversations · Read-only

List the conversations of a WABA number, most recently active first.
Returns conversations with contact, session_key and latest activity.
Use twochat_waba_conversation_messages_list for one contact's messages.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `channel_uuid` (`string`, required): UUID of your WABA number (starts with WAN), from twochat_whatsapp_numbers_list. Example: WAN95841312-b54d-46e3-b0bc-6414f4a5296b.
- `page_number` (`integer`, optional): Zero-based page number. Defaults to 0. Example: 0.
- `phone_number` (`string`, optional): Only contacts whose number contains these 3 to 20 digits. Example: 123456.
- `results_per_page` (`integer`, optional): Conversations per page, from 1 to 200. Defaults to 10. Example: 20.

Example input: `{"channel_uuid":"<channel_uuid>"}`

### `twochat_waba_template_get`

Get WABA Template · Read-only

Get one WABA template with its approval status, the variables it needs and an example send body.
Returns the template's components, status, variables and example_payload.
Use this before twochat_waba_message_send to fill params correctly.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `template_uuid` (`string`, required): Template UUID (starts with TMP). Example: TMP1b44a079-c75c-4403-bc8f-a75c4ce5cd23.
- `fields_format` (`string`, optional): Set flat to also get a fields array with one form field per variable. Example: flat. One of: `flat`.

Example input: `{"template_uuid":"<template_uuid>"}`

### `twochat_waba_templates_list`

List WABA Templates · Read-only

List the WhatsApp Business API message templates of one of your WABA numbers.
Returns templates with uuid, name, language, category and approval status.
Use this to get a template_uuid for twochat_waba_message_send.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `phone_number` (`string`, required): Your WABA number in international format. Example: +5215512345432.
- `limit` (`integer`, optional): Templates per page, from 10 to 200. Defaults to 10. Example: 50.
- `page` (`integer`, optional): Zero-based page. Defaults to 0. Example: 0.

Example input: `{"phone_number":"<phone_number>"}`

### `twochat_webhooks_list`

List Webhooks · Read-only

List all webhook subscriptions configured on your 2Chat account.
Returns subscriptions with uuid, event name, hook URL, channel and status.
Use this to find a webhook UUID for twochat_webhook_delete.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `twochat_whatsapp_conversation_messages_list`

List WhatsApp Conversation Messages · Read-only

List the messages between your connected WhatsApp number and one contact, newest first.
Returns messages with uuid, session_key, direction, text, media and timestamps.
Use twochat_whatsapp_messages_list for all contacts.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `from_number` (`string`, required): Your connected WhatsApp number, in international format. Example: +595981048477.
- `remote_number` (`string`, required): The contact's phone number in international format. Example: +595981111111.
- `page_number` (`integer`, optional): Page of older messages to return, starting at 0. Example: 0.

Example input: `{"from_number":"<from_number>","remote_number":"<remote_number>"}`

### `twochat_whatsapp_conversations_list`

List WhatsApp Conversations · Read-only

List the conversations on a connected WhatsApp number, most recent first, 10 per page.
Returns conversations with session_key, contact, last message and timestamps.
Use this to poll for new messages or find a session_key.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `channel_uuid` (`string`, required): UUID of the connected WhatsApp number (starts with WPN), from twochat_whatsapp_numbers_list. Example: WPN66037eca-9ad1-4c96-9eff-526a90a48c77.
- `page_number` (`integer`, optional): Zero-based page number. Defaults to 0. Example: 0.
- `phone_number` (`string`, optional): Only conversations whose contact number contains these 3 to 20 digits. Example: 123456.

Example input: `{"channel_uuid":"<channel_uuid>"}`

### `twochat_whatsapp_group_get`

Get WhatsApp Group · Read-only

Get a WhatsApp group's details and participants.
Returns the group's name, description and participants with their phone numbers and admin roles.
Use twochat_whatsapp_groups_list to find the group UUID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `group_uuid` (`string`, required): WhatsApp group UUID (starts with WAG), from twochat_whatsapp_groups_list. Example: WAG45b0f301-9203-4660-8b57-b51a6c2742a5.

Example input: `{"group_uuid":"<group_uuid>"}`

### `twochat_whatsapp_group_messages_list`

List WhatsApp Group Messages · Read-only

List the messages of a WhatsApp group your connected number is in, newest first, 50 per page.
Returns messages with uuid, sender, text, media and timestamps.
Use twochat_whatsapp_groups_list to find the group UUID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `group_uuid` (`string`, required): WhatsApp group UUID (starts with WAG), from twochat_whatsapp_groups_list. Example: WAG45b0f301-9203-4660-8b57-b51a6c2742a5.
- `page_number` (`integer`, optional): Page of older messages to return, starting at 0. Example: 0.

Example input: `{"group_uuid":"<group_uuid>"}`

### `twochat_whatsapp_groups_list`

List WhatsApp Groups · Read-only

List the WhatsApp groups a connected number is a participant of.
Returns groups with uuid (WAG...), name and details.
Use this to get a group UUID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `from_number` (`string`, required): Your connected WhatsApp number, in international format. Example: +595981048477.

Example input: `{"from_number":"<from_number>"}`

### `twochat_whatsapp_message_get`

Get WhatsApp Message · Read-only

Get one WhatsApp message sent or received through 2Chat.
Returns the message's uuid, text, media, direction, status and timestamps.
Use the session_key and uuid returned when the message was sent or listed.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `message_uuid` (`string`, required): Message UUID (starts with MSG). Example: MSG205dec10-523d-4ab3-b739-fd56e7cdeba2.
- `session_key` (`string`, required): Session key of the conversation the message belongs to. Example: WW-WPN66037eca-9ad1-4c96-9eff-526a90a48c77-5215511112222@c.us.

Example input: `{"message_uuid":"<message_uuid>","session_key":"<session_key>"}`

### `twochat_whatsapp_messages_list`

List WhatsApp Messages · Read-only

List the messages sent and received on a connected WhatsApp number, newest first, 100 per page.
Returns messages with uuid, session_key, direction, text, media, sender and timestamps.
Use twochat_whatsapp_conversation_messages_list for one contact's messages.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `from_number` (`string`, required): Your connected WhatsApp number, in international format. Example: +595981048477.
- `page_number` (`integer`, optional): Page of older messages to return, starting at 0. Example: 0.

Example input: `{"from_number":"<from_number>"}`

### `twochat_whatsapp_number_check`

Check Number on WhatsApp · Read-only

Check whether a phone number has a WhatsApp account, using one of your connected numbers.
Returns whether the number is on WhatsApp and, with extra_information, profile details.
Use this before messaging a new number. Checking in bulk can get your number banned.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `from_number` (`string`, required): Your WhatsApp number connected to 2Chat, in international format. Example: +595981048477.
- `number_to_check` (`string`, required): Phone number to check, in international format. Example: +17137157533.
- `extra_information` (`boolean`, optional): Set true to also return WhatsApp profile details. Costs 2 API credits instead of 1. Example: false.

Example input: `{"from_number":"<from_number>","number_to_check":"<number_to_check>"}`

### `twochat_whatsapp_number_get`

Get WhatsApp Number · Read-only

Get one connected WhatsApp number by its UUID.
Returns the number's uuid, phone number, name, status and settings.
Use twochat_whatsapp_number_status_get for its connection events.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `channel_uuid` (`string`, required): UUID of the connected WhatsApp number (starts with WPN), from twochat_whatsapp_numbers_list. Example: WPN66037eca-9ad1-4c96-9eff-526a90a48c77.

Example input: `{"channel_uuid":"<channel_uuid>"}`

### `twochat_whatsapp_number_status_get`

Get WhatsApp Number Status · Read-only

Get the connection status and latest connection events of a connected WhatsApp number.
Returns the status and recent events.
Use this to check a number is connected before sending.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `channel_uuid` (`string`, required): UUID of the connected WhatsApp number (starts with WPN), from twochat_whatsapp_numbers_list. Example: WPN66037eca-9ad1-4c96-9eff-526a90a48c77.

Example input: `{"channel_uuid":"<channel_uuid>"}`

### `twochat_whatsapp_numbers_list`

List WhatsApp Numbers · Read-only

List the WhatsApp numbers connected to 2Chat.
Returns numbers with uuid (WPN...), phone number, name, connection status and settings.
Use this to get channel UUIDs and from_number values.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page_number` (`integer`, optional): Page number to return. Example: 0.
- `results_per_page` (`integer`, optional): Numbers per page. Defaults to 50. Example: 20.
- `status` (`string`, optional): Filter by connection status. Defaults to all. Example: connected. One of: `connected`, `disconnected`, `all`.

Example input: `{}`

### `twochat_contact_create`

Create Contact · Write

Create a contact in your 2Chat directory, and on a connected WhatsApp account when channel_uuid is set.
Returns the new contact with uuid, names, channel_uuid and details.
Create a contact before messaging a new number to lower the risk of WhatsApp bans.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `contact_detail` (`array`, required): Contact details, each with a type and a value. Types: PH phone, WAPH phone with WhatsApp, E email, A postal address. Use international format for phones. Example: [{"type": "WAPH", "value": "+12125550147"}, {"type": "E", "value": "kate@example.com"}]
- `first_name` (`string`, required): Contact's first name. Example: Kate.
- `channel_uuid` (`string`, optional): UUID of a connected WhatsApp number (WPN...). When set, the contact is also saved on that WhatsApp account. Example: WPN66037eca-9ad1-4c96-9eff-526a90a48c77.
- `last_name` (`string`, optional): Contact's last name. Example: Smith.
- `profile_pic_url` (`string`, optional): Public URL of the contact's picture. Example: https://example.com/kate.jpg.

Example input: `{"contact_detail":[{"type":"WAPH","value":"+12125550147"},{"type":"E","value":"kate@example.com"}],"first_name":"<first_name>"}`

### `twochat_contact_update`

Update Contact · Write

Update a 2Chat contact's names, picture, linked WhatsApp number or details.
Returns the updated contact.
When channel_uuid is set the contact is also created or updated on that WhatsApp account.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `contact_uuid` (`string`, required): Contact UUID (starts with CON), from twochat_contacts_list or twochat_contacts_search. Example: CON58147f7c-3756-4ca1-893c-c3360342b424.
- `channel_uuid` (`string`, optional): UUID of a connected WhatsApp number (WPN...). When set, the contact is also saved on that WhatsApp account. Example: WPN66037eca-9ad1-4c96-9eff-526a90a48c77.
- `contact_detail` (`array`, optional): Contact details, each with a type and a value. Types: PH phone, WAPH phone with WhatsApp, E email, A postal address. Use international format for phones. Example: [{"type": "WAPH", "value": "+12125550147"}, {"type": "E", "value": "kate@example.com"}]
- `first_name` (`string`, optional): Contact's first name. Example: Kate.
- `last_name` (`string`, optional): Contact's last name. Example: Smith.
- `profile_pic_url` (`string`, optional): Public URL of the contact's picture. Example: https://example.com/kate.jpg.

Example input: `{"contact_uuid":"<contact_uuid>"}`

### `twochat_conversation_assign_team`

Assign Conversation to Team · Write

Assign a conversation to a team, replacing the previous team. Every team member can then open it.
Returns the new assignment.
Use twochat_teams_list for the team_uuid.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `session_key` (`string`, required): The conversation's session_key, from twochat_conversations_search, twochat_whatsapp_conversations_list or a message. Example: WA-WAN8fd3442f-e111-4fed-9323-1824fd7546c9-14085550176.
- `team_uuid` (`string`, required): UUID of a team, from twochat_teams_list. Example: VUGa71c3e09-8b52-4f0d-9d1e-5c6b2f8e4a10.

Example input: `{"session_key":"<session_key>","team_uuid":"<team_uuid>"}`

### `twochat_conversation_assign_user`

Assign Conversation to User · Write

Assign a conversation to a user of your account, replacing the previous user. The team assignment stays.
Returns the new assignment.
Use twochat_users_list for the user_uuid.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `session_key` (`string`, required): The conversation's session_key, from twochat_conversations_search, twochat_whatsapp_conversations_list or a message. Example: WA-WAN8fd3442f-e111-4fed-9323-1824fd7546c9-14085550176.
- `user_uuid` (`string`, required): UUID of an active user, from twochat_users_list. Example: USR4f1c8a73-2e91-4d6b-9c44-1a72bfe0d521.

Example input: `{"session_key":"<session_key>","user_uuid":"<user_uuid>"}`

### `twochat_conversation_note_create`

Add Conversation Note · Write

Add an internal note to a conversation, visible only to your team in the live chat and never sent to the contact. Mentioned users are notified.
Returns the created note.
Write each mentioned user's UUID in the text where the mention should appear.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `session_key` (`string`, required): The conversation's session_key, from twochat_conversations_search, twochat_whatsapp_conversations_list or a message. Example: WA-WAN8fd3442f-e111-4fed-9323-1824fd7546c9-14085550176.
- `text` (`string`, required): The note, up to 2000 characters of plain text. Example: The customer asked for an invoice. USR4f1c8a73-2e91-4d6b-9c44-1a72bfe0d521 can you send it?.
- `mentions` (`array`, optional): UUIDs of users to mention, up to 20, from twochat_users_list. Example: ["USR4f1c8a73-2e91-4d6b-9c44-1a72bfe0d521"]

Example input: `{"session_key":"<session_key>","text":"<text>"}`

### `twochat_conversation_tag_add`

Add Tag to Conversation · Write

Put an existing tag on a conversation. Nothing changes if it already has the tag.
Returns the conversation's tags.
Use twochat_tag_create with session_key to create and add a tag in one call.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `session_key` (`string`, required): The conversation's session_key. Example: WA-WAN8fd3442f-e111-4fed-9323-1824fd7546c9-14085550176.
- `tag_uuid` (`string`, required): Tag UUID (starts with TAG), from twochat_tags_list or twochat_tag_create. Example: TAGd37f22fa-fe01-4a90-b57d-7e83ccc6a05a.

Example input: `{"session_key":"<session_key>","tag_uuid":"<tag_uuid>"}`

### `twochat_conversation_tag_remove`

Remove Tag from Conversation · Write

Take a tag off one conversation; the tag stays in the account.
Returns the conversation's remaining tags.
Use twochat_tag_delete to delete the tag everywhere.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `session_key` (`string`, required): The conversation's session_key, from twochat_conversations_search, twochat_whatsapp_conversations_list or a message. Example: WA-WAN8fd3442f-e111-4fed-9323-1824fd7546c9-14085550176.
- `tag_uuid` (`string`, required): Tag UUID (starts with TAG), from twochat_tags_list or twochat_tag_create. Example: TAGd37f22fa-fe01-4a90-b57d-7e83ccc6a05a.

Example input: `{"session_key":"<session_key>","tag_uuid":"<tag_uuid>"}`

### `twochat_conversation_unassign_team`

Unassign Conversation Team · Write

Remove the assigned team from a conversation; the user stays.
Returns the current assignment.
Use twochat_conversation_unassign_user to remove the user.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `session_key` (`string`, required): The conversation's session_key, from twochat_conversations_search, twochat_whatsapp_conversations_list or a message. Example: WA-WAN8fd3442f-e111-4fed-9323-1824fd7546c9-14085550176.

Example input: `{"session_key":"<session_key>"}`

### `twochat_conversation_unassign_user`

Unassign Conversation User · Write

Remove the assigned user from a conversation; the team stays.
Returns the current assignment.
Use twochat_conversation_unassign_team to remove the team.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `session_key` (`string`, required): The conversation's session_key, from twochat_conversations_search, twochat_whatsapp_conversations_list or a message. Example: WA-WAN8fd3442f-e111-4fed-9323-1824fd7546c9-14085550176.

Example input: `{"session_key":"<session_key>"}`

### `twochat_scheduled_message_send_now`

Send Scheduled Message Now · Write

Send a pending scheduled WhatsApp message right away. For a series, later sends are counted from now.
Returns the scheduled message with next_send_at_utc set to now.
Only messages with status pending can be sent now.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `uuid` (`string`, required): UUID of the scheduled message (starts with EST). Example: EST83feed3c-4f8d-446b-8cbc-4efcc14ef901.

Example input: `{"uuid":"<uuid>"}`

### `twochat_sms_send`

Send SMS · Write

Send an SMS text from one of your 2Chat SMS numbers. A2P messages to US numbers are not supported.
Returns the sent message's details.
Messages over 160 characters are split and billed per segment.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `from_number` (`string`, required): Your 2Chat SMS number in international format. Example: +17137157533.
- `text` (`string`, required): Message text. Example: Hello from 2Chat!.
- `to_number` (`string`, required): Recipient phone number in international format. Example: +442079460958.

Example input: `{"from_number":"<from_number>","text":"<text>","to_number":"<to_number>"}`

### `twochat_tag_create`

Create Tag · Write

Create a conversation tag, or get the existing one with that name, and optionally put it on a conversation.
Returns the tag with uuid, name and color.
Safe to call whenever you need a tag. Use twochat_tag_update to set its color.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `name` (`string`, required): Tag name, up to 100 characters. Matching ignores case. Example: Hot lead.
- `session_key` (`string`, optional): A conversation to put the tag on. Example: WA-WAN8fd3442f-e111-4fed-9323-1824fd7546c9-14085550176.

Example input: `{"name":"<name>"}`

### `twochat_tag_update`

Update Tag · Write

Rename a tag or change its color everywhere it is used. Send at least one of name or color.
Returns the updated tag.
Use twochat_tags_list to find the tag UUID.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `tag_uuid` (`string`, required): Tag UUID (starts with TAG), from twochat_tags_list or twochat_tag_create. Example: TAGd37f22fa-fe01-4a90-b57d-7e83ccc6a05a.
- `color` (`string`, optional): Hex color as #RRGGBB. Example: #378ADD.
- `name` (`string`, optional): New name, up to 100 characters. Example: Qualified lead.

Example input: `{"tag_uuid":"<tag_uuid>"}`

### `twochat_waba_message_send`

Send WABA Message · Write

Send a WhatsApp Business API message: an approved template (to start a conversation or after 24 hours) or a free-form text within the 24-hour window.
Returns the sent message's details.
Send template_uuid with params, or text, not both. Use twochat_waba_template_get to see a template's variables and twochat_waba_conversation_window_get to check the window.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `from_number` (`string`, required): Your WABA number in international format. Example: +5215512345432.
- `to_number` (`string`, required): Recipient number in international format. Example: +595981048477.
- `params` (`object`, optional): Template variable values: body (values for the body placeholders, in order), header (text header values), header_media_url and header_media_filename (media headers) and button (dynamic URL button value). Send {} when the template has no variables. Example: {"body": ["Ana", "Tuesday 10:00"]}
- `template_uuid` (`string`, optional): UUID of an APPROVED template (starts with TMP), from twochat_waba_templates_list. Example: TMP1b44a079-c75c-4403-bc8f-a75c4ce5cd23.
- `text` (`string`, optional): Free-form text, up to 4096 characters. Only delivered while the 24-hour window is open. Example: Thanks for your message, we will reply shortly.

Example input: `{"from_number":"<from_number>","to_number":"<to_number>"}`

### `twochat_webhook_subscribe`

Subscribe to Webhook Event · Write

Subscribe a URL to a 2Chat event (WhatsApp, WhatsApp Business API or phone call) so 2Chat POSTs each event to it.
Returns the new webhook subscription with its uuid.
Use twochat_webhooks_list to review and twochat_webhook_delete to remove subscriptions.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `event_name` (`string`, required): The event to subscribe to. Example: whatsapp.message.received. One of: `whatsapp.message.received`, `whatsapp.message.sent`, `whatsapp.message.new`, `whatsapp.order.received`, `whatsapp.call.received`, `whatsapp.call.made`, `whatsapp.conversation.new`, `whatsapp.audio.transcribed`, `whatsapp.message.reaction`, `whatsapp.message.edited`, `whatsapp.message.deleted`, `whatsapp.group.message.received`, `whatsapp.group.message.reaction`, `whatsapp.group.join`, `whatsapp.group.leave`, `whatsapp.group.remove`, `whatsapp.message.receipt.sent`, `whatsapp.message.receipt.not-sent`, `whatsapp.message.receipt.received`, `whatsapp.message.receipt.read`, `whatsapp.number.status`, `whatsapp.waba.message.sent`, `whatsapp.waba.message.received`, `whatsapp.waba.message.order.received`, `whatsapp.waba.message.receipt.sent`, `whatsapp.waba.message.receipt.received`, `whatsapp.waba.message.receipt.read`, `whatsapp.waba.message.failed`, `whatsapp.waba.template.status.updated`, `call.status.update`, `call.incoming.completed`, `call.outbound.completed`.
- `hook_url` (`string`, required): Public URL that 2Chat calls when the event happens. Example: https://example.com/hooks/2chat.
- `on_number` (`string`, optional): Your connected number the event should fire for, in international format. Example: +595981048477.
- `time_period` (`string`, optional): Only for whatsapp.conversation.new: how long without messages before a conversation counts as new. Defaults to all-time. Example: day. One of: `all-time`, `hour`, `day`, `week`, `month`, `year`.
- `to_group_uuid` (`string`, optional): Only for group events: fire only for this group UUID (WAG...). Defaults to any group. Example: WAG768beeef-2b96-4bc7-9b7f-045078568723.

Example input: `{"event_name":"whatsapp.message.received","hook_url":"<hook_url>"}`

### `twochat_whatsapp_group_create`

Create WhatsApp Group · Write

Create a WhatsApp group from your connected number with up to 10 initial participants. WhatsApp limits how many groups a number can create per day.
Returns the new group with its uuid.
Use twochat_whatsapp_group_participants_add to add more people afterwards.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `from_number` (`string`, required): Your WhatsApp number connected to 2Chat, in international format. Example: +595981048477.
- `name` (`string`, required): Group name. Example: Customer onboarding.
- `participants` (`array`, required): Phone numbers to add, in international format, up to 10. Example: ["+17137157533", "+18647351567"]
- `description` (`string`, optional): Group description. Example: Questions about getting started.

Example input: `{"from_number":"<from_number>","name":"<name>","participants":["+17137157533","+18647351567"]}`

### `twochat_whatsapp_group_description_set`

Set WhatsApp Group Description · Write

Set the description text of a WhatsApp group.
Returns success.
Your number must be allowed to edit the group's info.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `description` (`string`, required): The new description. Example: Questions about getting started.
- `from_number` (`string`, required): Your WhatsApp number connected to 2Chat, in international format. Example: +595981048477.
- `group_uuid` (`string`, required): WhatsApp group UUID (starts with WAG), from twochat_whatsapp_groups_list. Example: WAG45b0f301-9203-4660-8b57-b51a6c2742a5.

Example input: `{"description":"<description>","from_number":"<from_number>","group_uuid":"<group_uuid>"}`

### `twochat_whatsapp_group_participants_add`

Add WhatsApp Group Participants · Write

Add up to 10 phone numbers to a WhatsApp group.
Returns the result for each participant.
Create the contacts first with twochat_contact_create to lower the ban risk.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `from_number` (`string`, required): Your WhatsApp number connected to 2Chat, in international format. Example: +595981048477.
- `group_uuid` (`string`, required): WhatsApp group UUID (starts with WAG), from twochat_whatsapp_groups_list. Example: WAG45b0f301-9203-4660-8b57-b51a6c2742a5.
- `participants` (`array`, required): Phone numbers to add, in international format, up to 10. Example: ["+447700176576", "+17137157533"]

Example input: `{"from_number":"<from_number>","group_uuid":"<group_uuid>","participants":["+447700176576","+17137157533"]}`

### `twochat_whatsapp_message_schedule`

Schedule WhatsApp Message · Write

Schedule a WhatsApp message from a WhatsApp Web or WABA number to be sent later, once or on a recurring schedule.
Returns the scheduled message with uuid, status and next send time.
Send text or url. For recurring messages set repeat_unit and ends_type.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `from_number` (`string`, required): Your 2Chat number that sends the message, in international format. Example: +595981048477.
- `send_at` (`string`, required): When to send, as YYYY-MM-DD HH:MM in timezone. Must be in the future; for a series this is the first send. Example: 2026-12-01 09:00.
- `to_number` (`string`, required): Recipient phone number in international format. Example: +447700900461.
- `ends_date` (`string`, optional): When ends_type is date: last moment a send may go out, as YYYY-MM-DD HH:MM in timezone. Example: 2026-12-31 23:59.
- `ends_occurrences` (`integer`, optional): When ends_type is occurrences: total sends including the first. Example: 4.
- `ends_type` (`string`, optional): Recurring only: never, occurrences (after ends_occurrences sends) or date (until ends_date). Example: occurrences. One of: `never`, `occurrences`, `date`.
- `repeat_every` (`integer`, optional): Send every this many units, for example 2 with weekly for every other week. Defaults to 1. Example: 1.
- `repeat_unit` (`string`, optional): Makes the message recurring: minute, hourly, daily, weekly, monthly or yearly. Requires ends_type. Example: weekly. One of: `minute`, `hourly`, `daily`, `weekly`, `monthly`, `yearly`.
- `text` (`string`, optional): Message text. Send text or url. Example: Reminder: your appointment is tomorrow at 10:00.
- `timezone` (`string`, optional): IANA time zone for send_at and ends_date. Defaults to the account's time zone. Example: America/New_York.
- `url` (`string`, optional): Public URL of a media file to attach. Send text or url. Example: https://example.com/files/menu.pdf.

Example input: `{"from_number":"<from_number>","send_at":"<send_at>","to_number":"<to_number>"}`

### `twochat_whatsapp_message_send`

Send WhatsApp Message · Write

Send a WhatsApp text, media or location message from your connected number to a phone number, a username ID or a group.
Returns the sent message's uuid and session_key.
Set exactly one of to_number, to_remote_id or to_group_uuid. Use twochat_whatsapp_message_schedule to send later.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `from_number` (`string`, required): Your WhatsApp number connected to 2Chat that sends the message, in international format. Example: +595981048477.
- `pin` (`object`, optional): A location pin to send: latitude and longitude are required, name, address and url optional. Example: {"latitude": "-25.7752926", "longitude": "-56.647703", "name": "Our store", "address": "Some address 123"}
- `text` (`string`, optional): Message text. Also used as the caption of a media file. Example: Hi Kate, your order has shipped.
- `to_group_uuid` (`string`, optional): UUID of a WhatsApp group to send to (WAG...), from twochat_whatsapp_groups_list. Example: WAG768beeef-2b96-4bc7-9b7f-045078568723.
- `to_number` (`string`, optional): Recipient phone number in international format. Example: +5215512345432.
- `to_remote_id` (`string`, optional): Recipient username ID when there is no phone number, such as 123123123123@lid. Example: 123123123123@lid.
- `url` (`string`, optional): Public URL of an image, video, audio or PDF file to attach. Example: https://example.com/files/invoice.pdf.

Example input: `{"from_number":"<from_number>"}`

### `twochat_contact_delete`

Delete Contact · Destructive

Delete a contact from your 2Chat directory.
Returns success.
Use twochat_contacts_search to find the UUID first.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `contact_uuid` (`string`, required): Contact UUID (starts with CON), from twochat_contacts_list or twochat_contacts_search. Example: CON58147f7c-3756-4ca1-893c-c3360342b424.

Example input: `{"contact_uuid":"<contact_uuid>"}`

### `twochat_scheduled_message_cancel`

Cancel Scheduled Message · Destructive

Cancel a scheduled WhatsApp message, or stop a recurring series. This cannot be undone.
Returns success.
Use twochat_scheduled_messages_list to find the uuid.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `uuid` (`string`, required): UUID of the scheduled message (starts with EST). Example: EST6cc93513-1706-4ffc-a69e-174572d860dd.

Example input: `{"uuid":"<uuid>"}`

### `twochat_tag_delete`

Delete Tag · Destructive

Delete a tag from your account and from every conversation that has it. This cannot be undone.
Returns success.
Use twochat_conversation_tag_remove to take a tag off only one conversation.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `tag_uuid` (`string`, required): Tag UUID (starts with TAG), from twochat_tags_list or twochat_tag_create. Example: TAGd37f22fa-fe01-4a90-b57d-7e83ccc6a05a.

Example input: `{"tag_uuid":"<tag_uuid>"}`

### `twochat_webhook_delete`

Delete Webhook · Destructive

Delete a webhook subscription.
Returns success.
Use twochat_webhooks_list to find the webhook UUID (starts with WHK).

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `webhook_uuid` (`string`, required): Webhook UUID (starts with WHK). Example: WHK530c9d58-2259-4ce2-82a8-1941f3a60665.

Example input: `{"webhook_uuid":"<webhook_uuid>"}`

### `twochat_whatsapp_group_participants_remove`

Remove WhatsApp Group Participants · Destructive

Remove up to 10 participants from a WhatsApp group.
Returns the result for each participant.
Use twochat_whatsapp_group_get to see current participants.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `from_number` (`string`, required): Your WhatsApp number connected to 2Chat, in international format. Example: +595981048477.
- `group_uuid` (`string`, required): WhatsApp group UUID (starts with WAG), from twochat_whatsapp_groups_list. Example: WAG45b0f301-9203-4660-8b57-b51a6c2742a5.
- `participants` (`array`, required): Phone numbers to remove, in international format, up to 10. Example: ["+447700176576", "+17137157533"]

Example input: `{"from_number":"<from_number>","group_uuid":"<group_uuid>","participants":["+447700176576","+17137157533"]}`

### `twochat_whatsapp_message_delete`

Delete WhatsApp Message · Destructive

Delete a message from 2Chat and from WhatsApp, if it was sent up to 60 hours ago. In groups only admins can delete others' messages.
Returns success.
Use twochat_whatsapp_message_get to check the message first.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `message_uuid` (`string`, required): Message UUID (starts with MSG). Example: MSG205dec10-523d-4ab3-b739-fd56e7cdeba2.
- `session_key` (`string`, required): Session key of the conversation the message belongs to. Example: WW-WPN66037eca-9ad1-4c96-9eff-526a90a48c77-5215511112222@c.us.

Example input: `{"message_uuid":"<message_uuid>","session_key":"<session_key>"}`

## Related

Other Communication connectors ([all 132](/agentkit/connectors/?category=communication)):

- [Gmail](/agentkit/connectors/gmail/): Scalekit connector, OAuth, 48 tools
- [Slack](/agentkit/connectors/slack/): Scalekit connector, OAuth, 96 tools
- [Google Calendar](/agentkit/connectors/googlecalendar/): Scalekit connector, OAuth, 30 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
