# Superchat

Superchat is a unified messaging platform that enables businesses to communicate with customers across multiple channels, including WhatsApp, Instagram Direct, Facebook Messenger, Email, and more.

- **Category:** team chat
- **Auth:** API_KEY
- **Tools:** 17
- **Triggers:** 0
- **Slug:** `SUPERCHAT`
- **Version:** 20260211_00

## Tools

### Create Contact

**Slug:** `SUPERCHAT_CREATE_CONTACT`

Create a new contact in Superchat with phone or email handles. Use this tool to register contact details before sending messages. You must provide at least one handle (phone or email). Optional fields include first name, last name, gender, and custom attributes (if predefined in your account settings).

### Create Template Folder

**Slug:** `SUPERCHAT_CREATE_TEMPLATE_FOLDER`

Create a new template folder in SuperChat for organizing message templates. Template folders help organize WhatsApp and other messaging templates into logical groups (e.g., Marketing, Sales, Customer Support). Use this action before creating templates when you want to keep them organized.

### Delete Webhook

**Slug:** `SUPERCHAT_DELETE_WEBHOOK`

Tool to delete a specific webhook by its ID. Use when you need to remove an obsolete or unwanted webhook subscription. First use SUPERCHAT_LIST_WEBHOOKS to retrieve the webhook ID, then use this action to delete it. Example: Delete webhook wh_UPYSN0Etofjl7lhhQ9yhL.

### Get Contact

**Slug:** `SUPERCHAT_GET_CONTACT`

Retrieve a specific contact's details by ID. Returns the contact's name, handles (phone, email, social), custom attributes, and timestamps. Use this to look up contact information before sending messages or updating contact details. Example: "Get contact details for co_abc123" or "Fetch info for contact co_xyz789".

### Get File

**Slug:** `SUPERCHAT_GET_FILE`

Retrieve metadata for a specific file by its ID. Returns file details including the file name, MIME type, API resource URL, and a temporary download link with expiration. Use this to get information about uploaded files before downloading or processing them.

### Get User

**Slug:** `SUPERCHAT_GET_USER`

Retrieve details of a specific user in the Superchat workspace by their user ID. Use this tool when you need to fetch profile information for a known user. Note: You can obtain user IDs by first calling the List Users action. Example user_id format: 'us_abc123xyz'

### List Channels

**Slug:** `SUPERCHAT_LIST_CHANNELS`

Lists all communication channels in your Superchat workspace. Channels represent different messaging mediums (WhatsApp, email, SMS, Telegram, Instagram, Facebook) through which conversations occur. Results are sorted by creation date (newest first) and can be paginated using 'limit', 'after', or 'before' parameters.

### List Contacts

**Slug:** `SUPERCHAT_LIST_CONTACTS`

List all contacts in the Superchat workspace with cursor-based pagination. Use this tool to browse contacts, find contact IDs, or export contact data. Results are sorted by creation date (newest first).

### List Conversations

**Slug:** `SUPERCHAT_LIST_CONVERSATIONS`

Retrieves a paginated list of all conversations in your Superchat account. Each conversation includes channel info, status (open/snoozed/done), assigned users, contacts, labels, and inbox details. Use this to browse conversations, find specific ones by status or channel, or get conversation IDs for further operations. Supports cursor-based pagination to handle large result sets.

### List Custom Attributes

**Slug:** `SUPERCHAT_LIST_CUSTOM_ATTRIBUTES`

List all custom attributes defined for contacts in your Superchat account. Custom attributes are user-defined fields that extend contact data beyond standard fields like name and email. Use this action to discover available custom attributes before reading or updating contact information. Supports cursor-based pagination for accounts with many custom attributes. Common use cases: - Discover available custom fields before updating contacts - Retrieve custom attribute types (string, number, date, select, etc.) - Get custom attribute IDs for use in other API calls

### List Inboxes

**Slug:** `SUPERCHAT_LIST_INBOXES`

Tool to list all inboxes. Use when you need to retrieve inbox IDs and metadata before sending or organizing messages.

### List Labels

**Slug:** `SUPERCHAT_LIST_LABELS`

List all labels in the Superchat workspace. Labels are used to categorize and organize conversations. Use this tool to retrieve available labels and their IDs, which can then be used to assign labels to conversations via the update conversation endpoint. Supports cursor-based pagination for workspaces with many labels.

### List Templates

**Slug:** `SUPERCHAT_LIST_TEMPLATES`

Tool to list all message templates. Use when you need to fetch available message templates.

### List Users

**Slug:** `SUPERCHAT_LIST_USERS`

Retrieve all users in the workspace. Returns user profiles including names, emails, roles, and contact info. Supports pagination for large workspaces. Use cases: - Get a directory of all workspace members - Find user IDs for other API operations - Audit user roles and permissions

### List Webhooks

**Slug:** `SUPERCHAT_LIST_WEBHOOKS`

Tool to list all webhooks configured in the workspace. Use this tool to: - Retrieve all active and paused webhooks - Get webhook IDs for use with update or delete operations - Check webhook status and event subscriptions Supports pagination via 'limit', 'after', and 'before' parameters.

### Update Contact

**Slug:** `SUPERCHAT_UPDATE_CONTACT`

Update information for a specific contact in Superchat. Use this tool to modify a contact's name, gender, handles (phone/email), or custom attributes. Requires the contact_id (prefixed with 'ct_') which can be obtained from List Contacts or Create Contact. Examples: - Update first name: {"contact_id": "ct_abc123", "first_name": "Jane"} - Update gender: {"contact_id": "ct_abc123", "gender": "female"} - Update phone handle: {"contact_id": "ct_abc123", "handles": [{"type": "phone", "value": "+1234567890"}]}

### Update Webhook

**Slug:** `SUPERCHAT_UPDATE_WEBHOOK`

Update an existing webhook's target URL and/or event subscriptions. Use this tool to: - Change the webhook delivery URL - Add or remove event subscriptions - Update event types the webhook listens to Note: Webhook status (ACTIVE/PAUSED) is automatically managed by the API and cannot be manually changed. Webhooks become PAUSED after 7 days of consistent delivery failures.
