Skip to docs navigation

2Chat integration guide

Verified

How to connect 2Chat to WEXTL and use its 1 trigger and 88 actions in your workflows. About 2Chat: Business messaging platform for WhatsApp, SMS and calls.

  • 1 trigger
  • 44 searches
  • 44 actions
  • Instant (webhooks)
  • Auth: API key

AI-assisted documentation23 min read

This documentation is compiled from our integration source code, internal specs for 2Chat, its official API documentation and anonymized requests logs we collect from our support team[2].

Open 2Chat on WEXTL →
  • 2Chat
  • WEXTL
  • Clearstream
  • Buttondown
  • Acumbamail
  • Chatwork
  • Bandwidth
  • CallPage
  • Arpoone
  • Brightcall
  • BotStar
  • Autocalls AI
  • CallTrackingMetrics
  • Circle
  • CallRail
  • Brevo
  • Cmercury
  • Callbell
  • ClickSend
  • Benchmark Email
  • Bland AI
  • AWS SES
  • DialMyCalls
  • AWS SQS
  • BatchDialer
  • Campsite
  • Dialpad
  • Aircall
  • Cisco Webex
  • Bluesky
  • CXOne Mpower
  • API KeypasswordRequired

    In 2Chat, open Developers, then API Access, and copy your API key. You can create a new key there at any time.[1]

  1. Log in to your WEXTL account, add the 2Chat node module to your workflow, and click Create new credential.Instant triggers use webhooks. Click Create a webhook first when adding one, then create the credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your 2Chat account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Watch Events

TriggerInstant trigger for 2Chat events.
Output fields[3]
FieldType
Eventtext
IDtext
UUIDtext
Conversation Keytext
Created Attext
Timestamptext
Remote Phone Numbertext
Channel Phone Numbertext
Channel UUIDtext
Sent Bytext
Message UUIDtext
Reactiontext
Edited Attext

28other output fields

Find a Number on WhatsApp

SearchWhatsApp registration check for a phone number.
Input fields[3]
FieldType
From NumberRequired
choice
Number to CheckRequired
text
Include Extra Detailsboolean
Output fields[3]
FieldType
Is Validboolean
On WhatsAppboolean
Numberobject
Country Codetext
Regiontext
Carriertext
Time Zonesarray
WhatsApp Infoobject
Number IDtext
Contact Profile Picturetext
Is Businessboolean
Is Enterpriseboolean
Verified Nametext
Short Nametext
Push Nametext
Verified Levelnumber
Status Texttext
Business Informationtext

Get a Call Price

SearchRate lookup before placing a call.
Input fields[3]
FieldType
Phone NumberRequired
text
Output fields[3]
FieldType
Prefixtext
Location Nametext
Price Per Minutenumber

Get a Contact

SearchSingle entry out of the contact directory.
Input fields[3]
FieldType
ContactRequired
choice
Output fields[3]
FieldType
UUIDtext
IDnumber
First Nametext
Last Nametext
Channel UUIDtext
Profile Picture URLtext
Detailsarray
Last Updatedtext

Get a WABA Conversation Window

SearchReply window status for a contact.
Input fields[3]
FieldType
WABA NumberRequired
choice
Contact NumberRequired
text
Output fields[3]
FieldType
Successboolean
Window Openboolean
Last Inbound Message Attext
Expires Attext
Seconds Leftnumber
Allowed Message Typesarray

Get a WABA Message

SearchSingle business message with status.
Input fields[3]
FieldType
Conversation KeyRequired
text
Message IDRequired
text
Output fields[3]
FieldType
IDtext
UUIDtext
Conversation Keytext
Messageobject
Texttext
Mediaobject
Created Attext
Remote Phone Numbertext
Sent Bytext
Is From Flow Runboolean
Is From APIboolean
Is From Chatterboolean
Is From Agentboolean
WhatsApp Message IDtext
Delivery Acknumber

5other output fields

Get a WABA Number

SearchBusiness number profile and state.
Input fields[3]
FieldType
WABA NumberRequired
choice
Output fields[3]
FieldType
UUIDtext
Account UUIDtext
Business IDtext
Friendly Nametext
Country Codetext
Verified Nametext
Phone Numbertext
Formatted Phone Numbertext
Phone Number IDtext
Channel Typetext
Connection Statustext
Enabledboolean
Display Nametext

8other output fields

Get a WABA Template

SearchTemplate details with required parameters.
Input fields[3]
FieldType
Template IDRequired
text
Output fields[3]
FieldType
Successboolean
Templateobject
UUIDtext
Nametext
Statustext
Categorytext
Languagetext
Template Contenttext
Contenttext
Descriptiontext
Componentsarray
Quality Scoretext
Required Paramsobject
Send Supportedboolean
Unsupported Reasonsarray
Bodyarray
Headerarray
Header Media URLtext
Header Media Filenametext
Buttonarray
Countsobject
Example Payloadtext
Messagetext

Get a WhatsApp Group

SearchGroup profile with its member list.
Input fields[3]
FieldType
Group IDRequired
text
Output fields[3]
FieldType
UUIDtext
Channel UUIDtext
WhatsApp Group IDtext
Profile Picture URLtext
WhatsApp Owner IDtext
Group Nametext
WhatsApp Created Attext
Subjecttext
Sizenumber
Is Mutedboolean
Is Read Onlyboolean
Channel Is Ownerboolean
Created Attext

4other output fields

Get a WhatsApp Message

SearchSingle message with its delivery state.
Input fields[3]
FieldType
Conversation KeyRequired
text
Message IDRequired
text
Output fields[3]
FieldType
IDtext
UUIDtext
Timestamptext
Conversation Keytext
Messageobject
Texttext
Mediaobject
Created Attext
Remote Phone Numbertext
Channel Phone Numbertext
Sent Bytext
Is From Flow Runboolean
Is From APIboolean
Is From Chatterboolean
Is From Agentboolean

6other output fields

Get a WhatsApp Number

SearchSingle connected number with details.
Input fields[3]
FieldType
WhatsApp NumberRequired
choice
Output fields[3]
FieldType
IDtext
UUIDtext
Friendly Nametext
Phone Numbertext
Country Codetext
Push Nametext
Servertext
Platformtext
Connection Statustext
Enabledboolean
Is Business Profileboolean
Channel Typetext
Sync Contactsboolean

4other output fields

Get Account Usage

SearchPlan, rate limit and credit consumption.
Output fields[3]
FieldType
Successboolean
Accountobject
Nametext
UUIDtext
On Trialboolean
Blockedboolean
Created Attext
Expires Attext
Limitsobject
Requests Per Minutenumber
Usageobject
API Request Countnumber
Max API Request Countnumber
Number Check Countnumber
Max Number Check Countnumber

Get an Ads Report

SearchAd-driven conversation totals.
Input fields[3]
FieldType
Dayschoice
WABA Numberchoice
Output fields[3]
FieldType
Successboolean
Fromtext
Totext
Daysarray
Totalsobject
Conversationsnumber
Adsnumber
Dailyarray
Adsarray
Timezonetext

Get an SMS Channel

SearchSingle SMS number with its capabilities.
Input fields[3]
FieldType
SMS NumberRequired
choice
Output fields[3]
FieldType
UUIDtext
Account UUIDtext
Virtual Number Setup UUIDtext
Phone Numbertext
Friendly Nametext
Country Codetext
Supports SMS Inboolean
Supports SMS Outboolean
Enabledboolean
Created Attext
Updated Attext

Get an SMS Message

SearchSingle text message with cost.
Input fields[3]
FieldType
Message IDRequired
text
Output fields[3]
FieldType
UUIDtext
Destinationtext
Sourcetext
Texttext
Directiontext
Fragmentsnumber
Pricenumber
Virtual Number Setup IDnumber
Created Attext
Updated Attext
Timestampnumber

Get Call Details

SearchBilling and agent data for one call.
Input fields[3]
FieldType
Call IDRequired
text
Output fields[3]
FieldType
UUIDtext
Account UUIDtext
Call IDtext
Directiontext
Activeboolean
Fromtext
To Numbertext
Country Codetext
Statustext
Is WhatsApp Callboolean
Is SIP Trunk Callboolean
Caller ID UUIDtext
Caller ID Usedtext

9other output fields

Get Conversation Tags

SearchTags attached to a chat.
Input fields[3]
FieldType
Conversation KeyRequired
text
LimitRequired
number
Output fields[3]
FieldType
UUIDtext
Nametext
Colortext
Exclude From Campaignsboolean
Created Attext
Updated Attext
Created By User IDnumber

Get Number Cities

SearchBuyable number locations by city.
Input fields[3]
FieldType
Country CodeRequired
text
Regionchoice
Output fields[3]
FieldType
IDnumber
City Nametext
Country Codetext

Get Number Regions

SearchRegions that offer phone numbers.
Input fields[3]
FieldType
Country CodeRequired
text
Output fields[3]
FieldType
IDnumber
Region Nametext
Country Codetext

Get Number Requirements

SearchCountry rules for number purchases.
Input fields[3]
FieldType
Country CodeRequired
text
Number Typechoice
Output fields[3]
FieldType
Requirementsarray

Get WhatsApp Number Status

SearchConnection status and pairing code.
Input fields[3]
FieldType
WhatsApp NumberRequired
choice
Output fields[3]
FieldType
Successboolean
Connection Statustext
QR Codetext
Eventsarray
Eventtext
Payloadtext
Created Attext

List Available Numbers

SearchBuyable numbers from one group.
Input fields[3]
FieldType
Group IDRequired
text
LimitRequired
number
Number Containstext
Output fields[3]
FieldType
IDtext
Numbertext

List Call History

SearchPast calls with status and numbers.
Input fields[3]
FieldType
LimitRequired
number
Directionchoice
To Numbertext
From Numbertext
Output fields[3]
FieldType
UUIDtext
Account UUIDtext
Call IDtext
Directiontext
Activeboolean
Fromtext
To Numbertext
Country Codetext
Statustext
Is WhatsApp Callboolean
Is SIP Trunk Callboolean
Caller ID UUIDtext
Caller ID Usedtext

8other output fields

List Caller IDs

SearchOutbound caller ID numbers.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
UUIDtext
Account UUIDtext
Channel UUIDtext
Phone Numbertext
Friendly Nametext
Country Codetext
Typetext
Verifiedboolean
Created Attext
Updated Attext
Expires Attext

List Catalog Collections

SearchCatalog groupings with approval state.
Input fields[3]
FieldType
From NumberRequired
choice
LimitRequired
number
Business Numbertext
Output fields[3]
FieldType
IDtext
Nametext
Is Approvedboolean
Approval Statustext
Productsarray

List Catalog Products

SearchCatalog items with price and approval.
Input fields[3]
FieldType
From NumberRequired
choice
LimitRequired
number
Business Numbertext
Output fields[3]
FieldType
IDtext
Is Hiddenboolean
URLtext
Nametext
Descriptiontext
Availabilitytext
Max Availablenumber
Can Appealboolean
Retailer IDtext
Checkmarkboolean
Is Approvedboolean
Approval Statustext
Pricetext

2other output fields

List Contacts

SearchDirectory contacts, filtered by number.
Input fields[3]
FieldType
LimitRequired
number
WhatsApp Numberchoice
Output fields[3]
FieldType
UUIDtext
IDnumber
First Nametext
Last Nametext
Channel UUIDtext
Profile Picture URLtext
Detailsarray

List Number Reservations

SearchNumbers held ahead of purchase.
Output fields[3]
FieldType
Reservationstext

List Number Types

SearchCategories of buyable numbers.
Output fields[3]
FieldType
IDnumber
Nametext

List SMS Channels

SearchLines that can send or receive SMS.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
UUIDtext
Account UUIDtext
Virtual Number Setup UUIDtext
Phone Numbertext
Friendly Nametext
Country Codetext
Supports SMS Inboolean
Supports SMS Outboolean
Enabledboolean
Created Attext
Updated Attext

List SMS Conversations

SearchContacts texting an SMS number.
Input fields[3]
FieldType
SMS NumberRequired
choice
LimitRequired
number
Output fields[3]
FieldType
Contacttext
Last Message Texttext
Last Message Directiontext
Last Message Timestampnumber
Last Message Attext
Message Countnumber

List SMS Messages

SearchOne SMS conversation thread.
Input fields[3]
FieldType
SMS NumberRequired
choice
Contact NumberRequired
text
LimitRequired
number
Output fields[3]
FieldType
UUIDtext
Destinationtext
Sourcetext
Texttext
Directiontext
Fragmentsnumber
Pricenumber
Virtual Number Setup IDnumber
Created Attext
Updated Attext
Timestampnumber

List Tags

SearchTags saved for chats.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
UUIDtext
Nametext
Colortext
Exclude From Campaignsboolean
Created Attext
Updated Attext
Created By User IDnumber

List Users

SearchAccount users with names and emails.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
UUIDtext
First Nametext
Last Nametext
Emailtext

List Virtual Numbers

SearchVirtual lines you own with their regions.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
UUIDtext
Account UUIDtext
Phone Numbertext
Formatted Phone Numbertext
Country Codetext
Region Nametext
Emojitext
Friendly Nametext
Record Inboundboolean
Is Toll Freeboolean
Provider Typetext
Priced Per Minuteboolean
Incoming Price Per Minutenumber

7other output fields

List WABA Conversations

SearchBusiness chats of one number.
Input fields[3]
FieldType
WABA NumberRequired
choice
LimitRequired
number
Phone Digitstext
Output fields[3]
FieldType
Conversation Keytext
Friendly Nametext
Region Nametext
Country Codetext
Devicetext
Channel UUIDtext
Phone Numbertext
Timezonetext
Profile Picture URLtext
Is Group Chatboolean
Last User Message Sent Attext
Last Activity Attext
Created Attext

1other output field

List WABA Messages

SearchBusiness messages, optionally per contact.
Input fields[3]
FieldType
WABA NumberRequired
choice
LimitRequired
number
Contact Numbertext
Output fields[3]
FieldType
IDtext
UUIDtext
Conversation Keytext
Messageobject
Texttext
Mediaobject
Created Attext
Remote Phone Numbertext
Channel Phone Numbertext
Sent Bytext

List WABA Templates

SearchTemplate catalog with approval state.
Input fields[3]
FieldType
WABA NumberRequired
choice
LimitRequired
number
Output fields[3]
FieldType
UUIDtext
Nametext
Statustext
Categorytext
Languagetext
Template Contenttext
Contenttext
Descriptiontext
Componentsarray
Quality Scoretext
Rejection Reasontext
Media URLtext
Updated Attext

1other output field

List WhatsApp Conversations

SearchChat overview for one WhatsApp line.
Input fields[3]
FieldType
WhatsApp NumberRequired
choice
LimitRequired
number
Phone Digitstext
Output fields[3]
FieldType
Conversation Keytext
Friendly Nametext
Region Nametext
Country Codetext
Devicetext
Channel UUIDtext
Phone Numbertext
Time Zonetext
Profile Picture URLtext
Is Group Chatboolean
Last User Message Sent Attext
Last Activity Attext
Created Attext

1other output field

List WhatsApp Group Messages

SearchPast posts inside a group chat.
Input fields[3]
FieldType
Group IDRequired
text
LimitRequired
number
Output fields[3]
FieldType
IDtext
UUIDtext
Conversation Keytext
Messageobject
Texttext
Mediaobject
Created Attext
2Chat Linktext
Sent Bytext
Participantobject
Phone Numbertext
Devicetext
Push Nametext

List WhatsApp Groups

SearchGroups joined by a number.
Input fields[3]
FieldType
From NumberRequired
choice
LimitRequired
number
Output fields[3]
FieldType
UUIDtext
Channel UUIDtext
WhatsApp Group IDtext
Profile Picture URLtext
WhatsApp Owner IDtext
Group Nametext
WhatsApp Created Attext
Subjecttext
Sizenumber
Is Mutedboolean
Is Read Onlyboolean
Channel Is Ownerboolean
Created Attext

2other output fields

List WhatsApp Messages

SearchChat messages, optionally per contact.
Input fields[3]
FieldType
From NumberRequired
choice
LimitRequired
number
Contact Numbertext
Output fields[3]
FieldType
UUIDtext
Timestamptext
Conversation Keytext
Messageobject
Texttext
Mediaobject
Remote Phone Numbertext
Channel Phone Numbertext
Sent Bytext

List WhatsApp Numbers

SearchConnected WhatsApp numbers with their status.
Input fields[3]
FieldType
LimitRequired
number
Statuschoice
Output fields[3]
FieldType
UUIDtext
Friendly Nametext
Phone Numbertext
Country Codetext
Push Nametext
Servertext
Platformtext
Connection Statustext
Enabledboolean
Is Business Profileboolean
Channel Typetext
Sync Contactsboolean
Created Attext

1other output field

Search Contacts

SearchName or number search over contacts.
Input fields[3]
FieldType
Search TextRequired
text
LimitRequired
number
WhatsApp Numberchoice
Output fields[3]
FieldType
UUIDtext
IDnumber
First Nametext
Last Nametext
Channel UUIDtext
Profile Picture URLtext
Detailsarray

Search Number Groups

SearchFinds purchasable number groups.
Input fields[3]
FieldType
Country CodeRequired
text
LimitRequired
number
Regionchoice
Citychoice
City Name or Prefixtext
Number Typechoice
Output fields[3]
FieldType
IDtext
Prefixtext
Locationtext
Priceobject
Setup Pricetext
Monthly Pricetext
Typetext
Requirementsarray
Allow Number Selectionboolean
Eligible For Free Numberboolean
Featuresarray

Add a Catalog Collection

ActionNew collection with optional starting products.
Input fields[3]
FieldType
From NumberRequired
choice
NameRequired
text
Productschoice
Output fields[3]
FieldType
Successboolean

Add a Catalog Product

ActionNew catalog item with an image and optional price.
Input fields[3]
FieldType
From NumberRequired
choice
NameRequired
text
Image URLRequired
text
Descriptiontext
Pricetext
Currencytext
Hiddenboolean
Product Linktext
Retailer IDtext
Output fields[3]
FieldType
Successboolean

Add a Tag to a Conversation

ActionLabels a chat with a saved tag.
Input fields[3]
FieldType
TagRequired
choice
Conversation KeyRequired
text
Output fields[3]
FieldType
UUIDtext
Nametext
Colortext
Exclude From Campaignsboolean
Created Attext
Updated Attext
Created By User IDnumber

Add Catalog Product Images

ActionGallery pictures for a catalog item.
Input fields[3]
FieldType
From NumberRequired
choice
ProductRequired
choice
Image URLsRequired
array
Image URLtext
Output fields[3]
FieldType
Successboolean

Add Group Participants

ActionAdds members by phone number.
Input fields[3]
FieldType
From NumberRequired
choice
GroupRequired
choice
Phone NumbersRequired
array
Phone Numbertext
Output fields[3]
FieldType
Successboolean
Participantstext

Cancel a Number Reservation

ActionGives up a held phone number.
Input fields[3]
FieldType
Reservation IDRequired
text
Output fields[3]
FieldType
Successboolean
Messagetext

Connect a WhatsApp Number

ActionReconnects a WhatsApp number to 2Chat.
Input fields[3]
FieldType
WhatsApp NumberRequired
choice
Output fields[3]
FieldType
Successboolean

Create a Contact

ActionNew directory contact with optional details.
Input fields[3]
FieldType
First NameRequired
text
Contact Detailsarray
Detailobject
Last Nametext
WhatsApp Numberchoice
Profile Picture URLtext
Output fields[3]
FieldType
UUIDtext
IDnumber
First Nametext
Last Nametext
Channel UUIDtext
Profile Picture URLtext
Detailsarray
Last Updatedtext

Create a Tag

ActionNew tag, optionally applied to a chat.
Input fields[3]
FieldType
NameRequired
text
Conversation Keytext
Output fields[3]
FieldType
UUIDtext
Nametext
Colortext
Exclude From Campaignsboolean
Created Attext
Updated Attext
Created By User IDnumber

Create a WABA Template

ActionMessage template filed for WhatsApp approval.
Input fields[3]
FieldType
WABA NumberRequired
choice
NameRequired
text
LanguageRequired
choice
CategoryRequired
choice
Bodytext
Headerchoice
Footertext
Body Examplesarray
Exampleobject
Header Exampletext
Buttonsarray
Buttonobject
Output fields[3]
FieldType
Successboolean
Templateobject
UUIDtext
Nametext
Statustext
Categorytext
Languagetext
Template Contenttext
Contenttext
Descriptiontext
Componentsarray
Quality Scoretext
Required Paramsobject
Send Supportedboolean
Unsupported Reasonsarray
Bodyarray
Headerarray
Header Media URLtext
Header Media Filenametext
Buttonarray
Countsobject
Example Payloadtext
Messagetext

Create a WhatsApp Connection

ActionBegins pairing a WhatsApp number.
Input fields[3]
FieldType
Phone NumberRequired
text
Friendly Nametext
Output fields[3]
FieldType
IDtext
UUIDtext
Friendly Nametext
Phone Numbertext
Country Codetext
Push Nametext
Servertext
Platformtext
Connection Statustext
Enabledboolean
Is Business Profileboolean
Channel Typetext
Sync Contactsboolean

4other output fields

Create a WhatsApp Group

ActionNew WhatsApp group seeded with members.
Input fields[3]
FieldType
From NumberRequired
choice
Group NameRequired
text
Phone NumbersRequired
array
Phone Numbertext
Descriptiontext
Output fields[3]
FieldType
UUIDtext
Nametext
WhatsApp Group IDtext
Participantstext
Accepted Numbersarray
Unaccepted Numbersarray

Delete a Catalog Collection

ActionDeletes a grouping of catalog items.
Input fields[3]
FieldType
From NumberRequired
choice
CollectionRequired
choice
Output fields[3]
FieldType
Successboolean

Delete a Catalog Product

ActionRemoves a listed item from your catalog.
Input fields[3]
FieldType
From NumberRequired
choice
ProductRequired
choice
Output fields[3]
FieldType
Successboolean

Delete a Catalog Product Image

ActionDeletes a gallery picture.
Input fields[3]
FieldType
From NumberRequired
choice
ProductRequired
choice
Image PositionRequired
number
Output fields[3]
FieldType
Successboolean

Delete a Contact

ActionDeletes a directory entry irreversibly.
Input fields[3]
FieldType
ContactRequired
choice
Output fields[3]
FieldType
Successboolean

Delete a Tag

ActionClears a tag from all chats.
Input fields[3]
FieldType
TagRequired
choice
Output fields[3]
FieldType
Successboolean

Delete a Virtual Number

ActionReleases a virtual phone line from your account.
Input fields[3]
FieldType
Virtual NumberRequired
choice
Output fields[3]
FieldType
Successboolean

Delete a WABA Template

ActionRemoves a template across all its languages.
Input fields[3]
FieldType
Template IDRequired
text
Output fields[3]
FieldType
Successboolean
Messagetext

Delete a WhatsApp Message

ActionRemoves a message in one conversation.
Input fields[3]
FieldType
Conversation KeyRequired
text
Message IDRequired
text
Output fields[3]
FieldType
Successboolean
Message UUIDtext
WhatsApp Message IDtext

Delete a WhatsApp Number

ActionUnlinks a WhatsApp line from 2Chat.
Input fields[3]
FieldType
WhatsApp NumberRequired
choice
Output fields[3]
FieldType
Successboolean

Demote Group Participants

ActionStrips group admin status.
Input fields[3]
FieldType
From NumberRequired
choice
GroupRequired
choice
Phone NumbersRequired
array
Phone Numbertext
Output fields[3]
FieldType
Successboolean
Participantstext

Disconnect a WhatsApp Number

ActionTakes a WhatsApp line offline.
Input fields[3]
FieldType
WhatsApp NumberRequired
choice
Output fields[3]
FieldType
Successboolean

Edit a Catalog Collection

ActionAdds or removes products in a collection.
Input fields[3]
FieldType
From NumberRequired
choice
CollectionRequired
choice
Products to Addchoice
Products to Removechoice
Output fields[3]
FieldType
Successboolean

Edit a Catalog Product

ActionEdits listing details of a catalog item.
Input fields[3]
FieldType
From NumberRequired
choice
ProductRequired
choice
Nametext
Image URLtext
Descriptiontext
Pricetext
Hiddenchoice
Product Linktext
Retailer IDtext
Clear Fieldschoice
Output fields[3]
FieldType
Successboolean

Make an API Call

universalCustom 2Chat REST API request.
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Keytext
Valuetext
Status codenumber

Promote Group Participants

ActionGrants group admin rights to members.
Input fields[3]
FieldType
From NumberRequired
choice
GroupRequired
choice
Phone NumbersRequired
array
Phone Numbertext
Output fields[3]
FieldType
Successboolean
Participantstext

Purchase a Number

ActionBuys a number from a chosen group.
Input fields[3]
FieldType
Group IDRequired
text
Numbertext
Output fields[3]
FieldType
Successboolean

Remove a Tag from a Conversation

ActionUnlabels a chat again.
Input fields[3]
FieldType
TagRequired
choice
Conversation KeyRequired
text
Output fields[3]
FieldType
Successboolean

Remove Group Participants

ActionGroup member removal by number.
Input fields[3]
FieldType
From NumberRequired
choice
GroupRequired
choice
Phone NumbersRequired
array
Phone Numbertext
Output fields[3]
FieldType
Successboolean
Participantstext

Reserve a Number

ActionTemporary hold on a number.
Input fields[3]
FieldType
Group IDRequired
text
Numbertext
Output fields[3]
FieldType
UUIDtext
Numbertext
Created Attext
Expires Attext

Send a WABA Message

ActionBusiness template or text message.
Input fields[3]
FieldType
From NumberRequired
choice
To NumberRequired
text
Templatechoice
Texttext
Header Media Filenametext
Body Valuesarray
Valueobject
Output fields[3]
FieldType
Successboolean
Batchedboolean
Message UUIDtext

Send a WhatsApp Message

ActionChat message with text, media or a map pin.
Input fields[3]
FieldType
From NumberRequired
choice
Send ToRequired
choice
ContentRequired
choice
Output fields[3]
FieldType
Successboolean
Batchedboolean
Message UUIDtext

Send an SMS Message

ActionOutbound SMS from a 2Chat number.
Input fields[3]
FieldType
From NumberRequired
choice
To NumberRequired
text
TextRequired
text
Output fields[3]
FieldType
Successboolean
Message UUIDtext

Set a Group Description

ActionNew description text for a WhatsApp group.
Input fields[3]
FieldType
From NumberRequired
choice
GroupRequired
choice
DescriptionRequired
text
Output fields[3]
FieldType
Successboolean

Set a Group Picture

ActionNew icon for a group chat.
Input fields[3]
FieldType
From NumberRequired
choice
GroupRequired
choice
Picture URLRequired
text
Output fields[3]
FieldType
Successboolean

Set a WhatsApp About Text

ActionProfile status line of a number.
Input fields[3]
FieldType
From NumberRequired
choice
About TextRequired
text
Output fields[3]
FieldType
Successboolean
Batchedboolean

Set a WhatsApp Image Status

ActionPicture status for a connected line.
Input fields[3]
FieldType
From NumberRequired
choice
Image URLRequired
text
Output fields[3]
FieldType
Successboolean

Set a WhatsApp Profile Picture

ActionSets or removes a profile photo.
Input fields[3]
FieldType
From NumberRequired
choice
Picture URLtext
Remove Pictureboolean
Output fields[3]
FieldType
Successboolean
Batchedboolean

Set a WhatsApp Text Status

ActionPosts a written status with an optional color.
Input fields[3]
FieldType
From NumberRequired
choice
TextRequired
text
Background Colortext
Fontnumber
Output fields[3]
FieldType
Successboolean

Set a WhatsApp Video Status

ActionShort clip status for a connected line.
Input fields[3]
FieldType
From NumberRequired
choice
Video URLRequired
text
Output fields[3]
FieldType
Successboolean

Sync WABA Templates

ActionPulls current templates from WhatsApp.
Input fields[3]
FieldType
WABA NumberRequired
choice
Output fields[3]
FieldType
Successboolean
Is Syncingboolean
Start Time Syncingtext
Messagetext

Update a Contact

ActionEdits contact names and picture.
Input fields[3]
FieldType
ContactRequired
choice
First Nametext
Last Nametext
WhatsApp Numberchoice
Profile Picture URLtext
Clear Fieldschoice
Output fields[3]
FieldType
UUIDtext
IDnumber
First Nametext
Last Nametext
Channel UUIDtext
Profile Picture URLtext
Detailsarray
Last Updatedtext

Update a Tag

ActionTag name and color changes.
Input fields[3]
FieldType
TagRequired
choice
Nametext
Colortext
Output fields[3]
FieldType
UUIDtext
Nametext
Colortext
Exclude From Campaignsboolean
Created Attext
Updated Attext
Created By User IDnumber

Look for 2Chat templates in the WEXTL template library.

Browse templates →
  1. WEXTL® 2Chat Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for 2Chat.
  4. WEXTL® visual workflow builder data.

Last updated: Nov 11, 2026 10:35

How we write our apps documentation

How we compile these docs: sources, the role of AI, and how we verify.