Sign in

v1

latestOpenAPI 3.0.32026-07-17410723.6 KB
Connections

post/connections/{phoneNumber}

Path parameters

phoneNumberstring required
Example:+551234567890

Phone number for connection. Must have + prefix.

Request body

clientNamestring

Name of the client to be used on WhatsApp connection

webhookUrlstring uri required

URL for receiving updates

webhookVerifyTokenstring required

Token for verifying webhook

includeMediaboolean

Include media in messages.upsert event payload as base64 string

syncFullHistoryboolean

Sync full history of messages on connection.

groupsEnabledboolean

Enable full group message processing. When false, group messages are accumulated and sent as activity summaries.

autoPresenceSubscribeboolean

Automatically subscribe to presence updates when sending/receiving messages or typing status to/from a contact. Subscriptions are ephemeral and re-established automatically.

Example request

{
  "clientName": "My WhatsApp Client",
  "webhookUrl": "http://localhost:3026/whatsapp/+1234567890",
  "webhookVerifyToken": "a3f4b2"
}

Response

Disconnected

widstring

WhatsApp ID of the business

descriptionstring

Business description

emailstring nullable

Business email

websitestring[]

Business websites

categorystring nullable

Business category

addressstring nullable

Business address

idstring

Group JID

addressingModestring

Addressing mode of the group

subjectstring

Group name/subject

subjectOwnerstring

JID of the user who set the subject

subjectOwnerPnstring

Phone number JID of the subject owner

subjectTimenumber

Timestamp when subject was set

sizenumber

Number of participants in the group

creationnumber

Timestamp when the group was created

ownerstring

JID of the group owner

ownerPnstring

Phone number JID of the group owner

owner_country_codestring

Country code of the group owner

descstring nullable

Group description

descIdstring nullable

Description ID

descOwnerstring nullable

JID of the user who set the description

descTimenumber nullable

Timestamp when description was set

restrictboolean

Whether only admins can change group settings

announceboolean

Whether only admins can send messages

isCommunityboolean

Whether the group is a community

isCommunityAnnounceboolean

Whether the group is a community announcement group

joinApprovalModeboolean

Whether join requests require admin approval

memberAddModeboolean

Whether members can add other members

ephemeralDurationnumber nullable

Duration in seconds for disappearing messages

Example response

{
  "data": {
    "jid": "551234567890@s.whatsapp.net",
    "profilePictureUrl": "https://pps.whatsapp.net/v/t61.24694-24/...",
    "enforcementType": "DEFAULT",
    "total_quota": 100,
    "capping_status": "NONE"
  },
  "wid": "551234567890@s.whatsapp.net",
  "description": "We are a company that sells products",
  "email": "contact@business.com",
  "website": [
    "https://business.com"
  ],
  "category": "Retail",
  "address": "123 Main St, City",
  "business_hours": {
    "timezone": "America/Sao_Paulo"
  },
  "id": "120363425378794738@g.us",
  "addressingMode": "lid",
  "subject": "My Group",
  "subjectOwner": "12345678901234@lid",
  "subjectOwnerPn": "551234567890@s.whatsapp.net",
  "owner": "12345678901234@lid",
  "ownerPn": "551234567890@s.whatsapp.net",
  "owner_country_code": "BR",
  "memberAddMode": true,
  "participants": [
    {
      "id": "12345678901234@lid",
      "phoneNumber": "551234567890@s.whatsapp.net",
      "admin": "superadmin"
    }
  ],
  "ephemeralDuration": 604800
}