- Category: team chat
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 17
- Triggers: 0
- Slug:
SUPERCHAT - Version: 20261101_00
Tools
Add Contact to Contact List
Add Contact to Contact List
Create Contact
Create Contact
Slug:
SUPERCHAT_CREATE_CONTACTCreate 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).Input Parameters
List of one or more contact handles (phone or email). At least one handle is required. Example: [{“type”: “phone”, “value”: “+14155552671”}] or [{“type”: “mail”, “value”: “user@example.com”}].
Optional list of custom attributes. NOTE: Custom attribute fields must be predefined in your Superchat account settings before they can be used via the API. Using undefined fields will result in a 400 error.
Output
Create Template Folder
Create Template Folder
Slug:
SUPERCHAT_CREATE_TEMPLATE_FOLDERCreate 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.Input Parameters
Output
Delete Webhook
Delete Webhook
Slug:
SUPERCHAT_DELETE_WEBHOOKTool 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.Input Parameters
Unique identifier of the webhook to delete, prefixed with ‘wh_’. Use SUPERCHAT_LIST_WEBHOOKS to retrieve available webhook IDs.
Output
Get Contact
Get Contact
Slug:
SUPERCHAT_GET_CONTACTRetrieve 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”.Input Parameters
The unique identifier of the contact. Superchat contact IDs always start with ‘ct_’ (e.g., ‘ct_T0WuvJS5pcg6TsTM1f03S’). You can obtain this ID from the List Contacts or Create Contact actions.
Output
Get File
Get File
Slug:
SUPERCHAT_GET_FILERetrieve 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.Input Parameters
Output
Get User
Get User
Slug:
SUPERCHAT_GET_USERRetrieve 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’Input Parameters
The unique identifier of the user to retrieve (format: us_xxx). Obtain user IDs from the List Users action.
Output
List Channels
List Channels
Slug:
SUPERCHAT_LIST_CHANNELSLists 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.Input Parameters
Output
List Contact Lists
List Contact Lists
List Contact Lists for Contact
List Contact Lists for Contact
List Contacts
List Contacts
List Conversations
List Conversations
Slug:
SUPERCHAT_LIST_CONVERSATIONSRetrieves 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.Input Parameters
Pagination cursor to retrieve the next page of results. Use the ‘next_cursor’ value from a previous response. Cannot be used with ‘before’. Omit for the first page.
Pagination cursor to retrieve the previous page of results. Use the ‘previous_cursor’ value from a previous response. Cannot be used with ‘after’. Omit for the first page.
Output
List Custom Attributes
List Custom Attributes
Slug:
SUPERCHAT_LIST_CUSTOM_ATTRIBUTESList 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 callsInput Parameters
Output
List Inboxes
List Inboxes
Slug:
SUPERCHAT_LIST_INBOXESTool to list all inboxes. Use when you need to retrieve inbox IDs and metadata before sending or organizing messages.Input Parameters
Cursor after which inboxes should be returned. Use for forward pagination. Cannot be used with ‘before’.
Cursor before which inboxes should be returned. Use for backward pagination. Cannot be used with ‘after’.
Output
List Labels
List Labels
Slug:
SUPERCHAT_LIST_LABELSList 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.Input Parameters
Cursor for pagination. Returns labels after this cursor position. Use the ‘next_cursor’ from a previous response.
Cursor for pagination. Returns labels before this cursor position. Use the ‘previous_cursor’ from a previous response. Cannot be used together with ‘after’.
Output
List Templates
List Templates
List Users
List Users
Slug:
SUPERCHAT_LIST_USERSRetrieve 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 permissionsInput Parameters
Output
List Webhooks
List Webhooks
Slug:
SUPERCHAT_LIST_WEBHOOKSTool 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.Input Parameters
Pagination cursor for older webhooks. Provide a webhook ID to retrieve the next page of results (webhooks created before this ID in chronological order). Results are sorted newest-first, so ‘after’ moves forward through older records. Cannot be used with ‘before’.
Pagination cursor for newer webhooks. Provide a webhook ID to retrieve the previous page of results (webhooks created after this ID in chronological order). Results are sorted newest-first, so ‘before’ moves backward through newer records. Cannot be used with ‘after’.
Output
Search Contacts
Search Contacts
Update Contact
Update Contact
Slug:
SUPERCHAT_UPDATE_CONTACTUpdate 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”}]}Input Parameters
List of contact handles to update. Only phone and email handles are supported. Include ‘id’ to update existing handles.
Unique identifier of the contact to update, prefixed with ‘ct_’. Example: ‘ct_abc123’.
Output
Update Webhook
Update Webhook
Slug:
SUPERCHAT_UPDATE_WEBHOOKUpdate an existing webhook’s target URL and/or event subscriptions. Event subscriptions are sent with empty filters, including when existing event types are retained during a URL-only update.Input Parameters
New target URL for the webhook. Must use HTTPS protocol. If omitted, the existing URL is preserved.
List of event types to subscribe to. Valid events: ‘message_inbound’, ‘contact_updated’, ‘contact_created’, ‘message_outbound’, ‘message_failed’, ‘note_created’, ‘conversation_done’, ‘conversation_opened’, ‘conversation_snoozed’. If omitted, the existing events are preserved.