Skip to main content
API docs by Redocly

WPPConnect API Rest (2.0.0)

Download OpenAPI specification:Download

Welcome to the wppconnect-server API documentation. This API provides a set of endpoints to interact with the wppconnect-server application, allowing you to build integrations and automate interactions with WhatsApp.

Auth

/api/{session}/{secretkey}/generate-token

path Parameters
session
required
string
Example: NERDWHATS_AMERICA
secretkey
required
string
Example: THISISMYSECURETOKEN

Responses

showAllSessions

Authorizations:
bearerAuth
path Parameters
secretkey
required
string
Example: THISISMYSECURETOKEN

Responses

startAllSessions

Authorizations:
bearerAuth
path Parameters
secretkey
required
string
Example: THISISMYSECURECODE
query Parameters
session
string
Example: session=NERDWHATS_AMERICA
header Parameters
authorization
string

Responses

CheckConnectionState

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA

Responses

getQrCode

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA

Responses

startSession

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
webhook
string
waitQrCode
boolean
object

Responses

Request samples

Content type
application/json
{
  • "webhook": "",
  • "waitQrCode": false,
  • "proxy": {}
}

logoutSession

This route logout and delete session data

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA

Responses

closeSession

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA

Responses

closeSession

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA

Responses

Chat

Manages chat-related operations.

Deprecated in favor of Deprecated

This body is not required. Not sent body to get all chats or filter.

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
query Parameters
phone
string
Example: phone=5521999999999
isGroup
string
Example: isGroup=false
includeMe
string
Example: includeMe=true
includeNotifications
string
Example: includeNotifications=false
messageId
required
string
Example: messageId=<messageId>
type
string
Example: type=all
count
string
Example: count=20
direction
string
Example: direction=before
id
string
Example: id=<message_id_to_use_direction>
status
string
response
string
Request Body schema: application/json
required
event
string
private
string

Responses

Request samples

Content type
application/json
{
  • "messageId": "conversation_status_changed",
  • "private": "false"
}

Retrieve a list of chats

This body is not required. Not sent body to get all chats or filter.

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
optional
id
string
count
number
direction
string
onlyGroups
boolean
onlyUsers
boolean
onlyWithUnreadMessage
boolean
withLabels
Array of arrays

Responses

Request samples

Content type
application/json
Example
{
  • "id": "<chatId>",
  • "count": 20,
  • "direction": "after",
  • "onlyGroups": false,
  • "onlyUsers": false,
  • "onlyWithUnreadMessage": false,
  • "withLabels": [ ]
}

Retrieves all archived chats.

Retrieves all archived chats.

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA

Responses

Deprecated in favor of list-chats Deprecated

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA

Responses

/api/{session}/all-messages-in-chat/{phone}

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
phone
required
string
Example: 5521999999999
query Parameters
isGroup
string
Example: isGroup=false
includeMe
string
Example: includeMe=true
includeNotifications
string
Example: includeNotifications=true

Responses

/api/{session}/all-new-messages

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA

Responses

/api/{session}/all-unread-messages

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA

Responses

/api/{session}/chat-by-id/{phone}

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
phone
required
string
Example: 5521999999999
query Parameters
isGroup
string
Example: isGroup=false

Responses

/api/{session}/message-by-id/{messageId}

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
messageId
required
string
Example: <message_id>

Responses

/api/{session}/chat-is-online/{phone}

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
phone
required
string
Example: 5521999999999

Responses

/api/{session}/last-seen/{phone}

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
phone
required
string
Example: 5521999999999

Responses

/api/{session}/list-mutes/{type}

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
type
required
string
Example: all

Responses

/api/{session}/load-messages-in-chat/{phone} Deprecated

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
phone
required
string
Example: 5521999999999
query Parameters
includeMe
string
Example: includeMe=true
includeNotifications
string
Example: includeNotifications=false

Responses

/api/{session}/archive-chat

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
optional
phone
string
isGroup
boolean
value
boolean

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "isGroup": false,
  • "value": true
}

/api/{session}/archive-all-chats

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA

Responses

/api/{session}/clear-chat

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
optional
phone
string
isGroup
boolean

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "isGroup": false
}

/api/{session}/clear-all-chats

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA

Responses

/api/{session}/delete-chat

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
optional
phone
string
isGroup
boolean

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "isGroup": false
}

/api/{session}/delete-all-chats

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA

Responses

/api/{session}/pin-chat

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
string
isGroup
boolean
state
boolean

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "state": true
}

/api/{session}/send-mute

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
string
isGroup
boolean
time
number
type
string

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "isGroup": false,
  • "time": 1,
  • "type": "hours"
}

/api/{session}/send-seen

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
string
isGroup
boolean

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "isGroup": false
}

/api/{session}/chat-state Deprecated

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
string
isGroup
boolean
chatstate
string

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "isGroup": false,
  • "chatstate": "1"
}

/api/{session}/typing

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
string
isGroup
boolean
value
boolean

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "isGroup": false,
  • "value": true
}

/api/{session}/recording

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
string
isGroup
boolean
duration
number
value
boolean

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "isGroup": false,
  • "duration": 5,
  • "value": true
}

/api/{session}/contact/{phone}

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
phone
required
string
Example: 5521999999999

Responses

/api/{session}/profile/{phone} Deprecated

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
phone
required
string
Example: 5521999999999

Responses

Contact

Handles operations related to contacts, such as managing contact lists, adding or removing contacts, and retrieving contact information.

/api/{session}/contact/pn-lid/{pnLid}

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
pnLid
required
string

Responses

/api/{session}/profile-pic/{phone}

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
phone
required
string
Example: 5521999999999
query Parameters
isGroup
string

Responses

/api/{session}/profile-status/{phone}

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
phone
required
string
Example: 5521999999999

Responses

Catalog & Bussiness

Handles operations related to catalogs and business-related functionalities, such as managing product catalogs and business information.

/api/{session}/get-products

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
query Parameters
phone
string
Example: phone=5521999999999
qnt
string
Example: qnt=10

Responses

/api/{session}/get-product-by-id

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
query Parameters
phone
string
Example: phone=5521999999999
id
string
Example: id=10

Responses

/api/{session}/add-product

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
name
string
image
string
description
string
price
string
url
string
retailerId
string
currency
string

Responses

Request samples

Content type
application/json
{
  • "name": "Product name",
  • "image": "<base64_string>",
  • "description": "Description for your product",
  • "price": "8890",
  • "url": "http://link_for_your_product.com",
  • "retailerId": "SKU001",
  • "currency": "BRL"
}

/api/{session}/edit-product

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
id
string
options
object

Responses

Request samples

Content type
application/json
{
  • "id": "<product_id>",
  • "options": {
    }
}

/api/{session}/del-products

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
id
string

Responses

Request samples

Content type
application/json
{
  • "id": "<product_id>"
}

/api/{session}/change-product-image

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
id
string
base64
string

Responses

Request samples

Content type
application/json
{
  • "id": "<product_id>",
  • "base64": "<base64_string>"
}

/api/{session}/add-product-image

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
id
string
base64
string

Responses

Request samples

Content type
application/json
{
  • "id": "<product_id>",
  • "base64": "<base64_string>"
}

/api/{session}/remove-product-image

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
id
string
index
number

Responses

Request samples

Content type
application/json
{
  • "id": "<product_id>",
  • "index": 1
}

/api/{session}/get-collections

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
query Parameters
phone
string
Example: phone=5521999999999
qnt
string
Example: qnt=10
max
string
Example: max=10

Responses

/api/{session}/create-collection

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
name
string
products
Array of arrays

Responses

Request samples

Content type
application/json
{
  • "name": "Collection name",
  • "products": [
    ]
}

/api/{session}/edit-collection

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
id
string
products
Array of arrays

Responses

Request samples

Content type
application/json
{
  • "id": "<product_id>",
  • "options": {
    }
}

/api/{session}/del-collection

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
id
string

Responses

Request samples

Content type
application/json
{
  • "id": "<product_id>"
}

/api/{session}/set-product-visibility

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
id
string
value
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "<product_id>",
  • "value": false
}

/api/{session}/set-cart-enabled

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

/api/{session}/get-business-profiles-products

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
query Parameters
phone
string
Example: phone=5521999999999@c.us

Responses

/api/{session}/get-order-by-messageId/{messageId}

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
messageId
required
string
Example: true_5521999999999@c.us_3EB0E69ACC5B396B21F2FE

Responses

Community

Manage communities.

/api/{session}/create-community

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
name
string
description
boolean
groupIds
Array of arrays

Responses

Request samples

Content type
application/json
{
  • "name": "My community name",
  • "description": "Description for your community",
  • "groupIds": [
    ]
}

/api/{session}/deactivate-community

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
id
string

Responses

Request samples

Content type
application/json
{
  • "id": "<you_community_id@g.us>"
}

/api/{session}/add-community-subgroup

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
id
string
groupsIds
Array of arrays

Responses

Request samples

Content type
application/json
{
  • "id": "<you_community_id@g.us>",
  • "groupsIds": [
    ]
}

/api/{session}/remove-community-subgroup

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
id
string
groupsIds
Array of arrays

Responses

Request samples

Content type
application/json
{
  • "id": "<you_community_id@g.us>",
  • "groupsIds": [
    ]
}

/api/{session}/promote-community-participant

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
id
string
participantsId
Array of arrays

Responses

Request samples

Content type
application/json
{
  • "id": "<you_community_id@g.us>",
  • "participantsId": [
    ]
}

/api/{session}/demote-community-participant

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
id
string
participantsId
Array of arrays

Responses

Request samples

Content type
application/json
{
  • "id": "<you_community_id@g.us>",
  • "participantsId": [
    ]
}

/api/{session}/community-participants/{id}

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
id
required
string
Example: communityId@g.us

Responses

Messages

Handles message-related operations, including sending, receiving, and managing messages.

getMediaByMessage

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: messageId
messageId
required
string

Responses

downloadMediabyMessage

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
messageId
string

Responses

Request samples

Content type
application/json
{
  • "messageId": "<messageId>"
}

/api/{session}/send-message

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
string
isGroup
boolean
isNewsletter
boolean
isLid
boolean
message
string
options
object

Responses

Request samples

Content type
application/json
Example
{
  • "phone": "5521999999999",
  • "isGroup": false,
  • "isNewsletter": false,
  • "isLid": false,
  • "message": "Hi from WPPConnect"
}

/api/{session}/edit-message

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
id
string
newText
string
options
object

Responses

Request samples

Content type
application/json
{
  • "id": "true_5521999999999@c.us_3EB04FCAA1527EB6D9DEC8",
  • "newText": "New text for message"
}

/api/{session}/send-image

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
string
isGroup
boolean
isNewsletter
boolean
isLid
boolean
filename
string
caption
string
base64
string

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "isGroup": false,
  • "isNewsletter": false,
  • "isLid": false,
  • "filename": "file name lol",
  • "caption": "caption for my file",
  • "base64": "<base64> string"
}

/api/{session}/send-sticker

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
required
string
isGroup
boolean
path
required
string

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "isGroup": true,
  • "path": "<path_file>"
}

/api/{session}/send-sticker-gif

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
required
string
isGroup
boolean
path
required
string

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "isGroup": true,
  • "path": "<path_file>"
}

/api/{session}/send-reply

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
string
isGroup
boolean
message
string
messageId
string

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "isGroup": false,
  • "message": "Reply to message",
  • "messageId": "<id_message>"
}

/api/{session}/send-file

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
string
isGroup
boolean
isNewsletter
boolean
isLid
boolean
filename
string
caption
string
base64
string

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "isGroup": false,
  • "isNewsletter": false,
  • "isLid": false,
  • "filename": "file name lol",
  • "caption": "caption for my file",
  • "base64": "<base64> string"
}

/api/{session}/send-file-base64

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
string
isGroup
boolean
isNewsletter
boolean
isLid
boolean
filename
string
caption
string
base64
string

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "isGroup": false,
  • "isNewsletter": false,
  • "isLid": false,
  • "filename": "file name lol",
  • "caption": "caption for my file",
  • "base64": "<base64> string"
}

/api/{session}/send-voice

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
string
isGroup
boolean
path
string
quotedMessageId
string

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "isGroup": false,
  • "path": "<path_file>",
  • "quotedMessageId": "message Id"
}

/api/{session}/send-voice-base64

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
string
isGroup
boolean
base64Ptt
string

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "isGroup": false,
  • "base64Ptt": "<base64_string>"
}

/api/{session}/send-status

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
required
string
isGroup
required
boolean
message
required
string
messageId
string

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "isGroup": false,
  • "message": "Reply to message",
  • "messageId": "<id_message>"
}

/api/{session}/send-location

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
string
isGroup
boolean
lat
string
lng
string
title
string
address
string

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "isGroup": false,
  • "lat": "-89898322",
  • "lng": "-545454",
  • "title": "Rio de Janeiro",
  • "address": "Av. N. S. de Copacabana, 25, Copacabana"
}

/api/{session}/send-mentioned

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
required
string
isGroup
boolean
message
required
string
mentioned
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "phone": "groupId@g.us",
  • "isGroup": true,
  • "message": "Your text message",
  • "mentioned": [
    ]
}

/api/{session}/send-buttons Deprecated

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA

Responses

/api/{session}/send-list-message

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
string
isGroup
boolean
description
string
sections
Array of arrays
buttonText
string

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "isGroup": false,
  • "description": "Desc for list",
  • "buttonText": "Select a option",
  • "sections": [
    ]
}

/api/{session}/send-order-message

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
string
isGroup
boolean
items
object
options
object

Responses

Request samples

Content type
application/json
Example
{
  • "phone": "5521999999999",
  • "isGroup": false,
  • "items": [
    ]
}

/api/{session}/send-poll-message

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
string
isGroup
boolean
name
string
choices
Array of arrays
options
object

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "isGroup": false,
  • "name": "Poll name",
  • "choices": [
    ],
  • "options": {
    }
}

/api/{session}/send-pix-key

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
required
string
keyType
required
string
name
required
string
key
required
string
instructions
string
options
object

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "keyType": "PHONE",
  • "name": "WPPCONNECT-TEAM",
  • "key": "+5567123456789",
  • "instructions": "some instructions about the pix",
  • "options": { }
}

/api/{session}/unread-messages Deprecated

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA

Responses

/api/{session}/get-messages/{phone}

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
phone
required
string
Example: 5521999999999@c.us
query Parameters
count
string
Example: count=20
direction
string
Example: direction=before
id
string
Example: id=<message_id_to_use_direction>

Responses

/api/{session}/delete-message

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
optional
phone
string
isGroup
boolean
messageId
string
onlyLocal
boolean
deleteMediaInDevice
boolean

Responses

Request samples

Content type
application/json
Example
{
  • "phone": "5521999999999",
  • "isGroup": false,
  • "messageId": "<messageId>",
  • "deleteMediaInDevice": true
}

/api/{session}/react-message

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
optional
msgId
string
reaction
string

Responses

Request samples

Content type
application/json
{
  • "msgId": "<messageId>",
  • "reaction": "😜"
}

/api/{session}/forward-messages

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
string
isGroup
boolean
messageId
string

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "isGroup": false,
  • "messageId": "<messageId>"
}

/api/{session}/mark-unseen

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
string
isGroup
boolean

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "isGroup": false
}

/api/{session}/contact-vcard

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
string
isGroup
boolean
name
string
contactsId
Array of arrays

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "isGroup": false,
  • "name": "Name of contact",
  • "contactsId": [
    ]
}

/api/{session}/temporary-messages

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
string
isGroup
boolean
value
boolean

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "isGroup": false,
  • "value": true
}

/api/{session}/star-message

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
messageId
string
star
boolean

Responses

Request samples

Content type
application/json
{
  • "messageId": "5521999999999",
  • "star": true
}

/api/{session}/reactions/{id}

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
id
required
string
query Parameters
messageId
string
Example: messageId=<messageId>

Responses

/api/{session}/votes/{id}

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
id
required
string
query Parameters
messageId
string
Example: messageId=<messageId>

Responses

Profile

Manages user profile-related operations, such as retrieving and updating profile information

/api/{session}/set-profile-pic

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA

Responses

/api/{session}/profile-status

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
status
string

Responses

Request samples

Content type
application/json
{
  • "status": "My new status"
}

/api/{session}/change-username

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
optional
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "My new name"
}

editBusinessProfile

Edit your bussiness profile

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
adress
string
email
string
categories
object
websites
Array of arrays

Responses

Request samples

Content type
application/json
{
  • "adress": "Av. Nossa Senhora de Copacabana, 315",
  • "email": "test@test.com.br",
  • "categories": {
    },
  • "website": []
}

Status Stories

Handles operations related to status stories, such as viewing, updating, and managing status stories

/api/{session}/send-text-storie

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
text
required
string
options
object

Responses

Request samples

Content type
application/json
{
  • "text": "My new storie",
  • "options": {
    }
}

/api/{session}/send-image-storie

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
path
required
string

Responses

Request samples

Content type
application/json
{
  • "path": "Path of your image"
}

/api/{session}/send-video-storie

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
path
required
string

Responses

Request samples

Content type
application/json
{
  • "path": "Path of your video"
}

Labels

Manages labels or tags associated with chats or messages for organization and categorization purposes.

/api/{session}/add-new-label

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
$name
string
object

Responses

Request samples

Content type
application/json
{
  • "name": "Name of your label",
  • "options": {
    }
}

/api/{session}/add-or-remove-label

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
chatIds
required
Array of strings
Array of objects

Responses

Request samples

Content type
application/json
{
  • "chatIds": [
    ],
  • "options": [
    ]
}

/api/{session}/get-all-labels

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA

Responses

/api/{session}/delete-all-labels

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA

Responses

/api/{session}/delete-label/{id}

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
id
required
string
Example: <labelId>

Responses

Group

Manages operations related to WhatsApp groups, such as creating, modifying, and managing group settings.

Deprecated in favor of Deprecated

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
query Parameters
groupId
string
Example: groupId=<groupId>
wid
string
Example: wid=5521999999999@c.us
Request Body schema: application/json
required
$groupId
string
$path
string

Responses

Request samples

Content type
application/json
{
  • "$groupId": "string",
  • "$path": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "response": {
    }
}

/api/{session}/group-members/{groupId}

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
groupId
required
string

Responses

/api/{session}/common-groups/{wid}

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
wid
required
string
Example: 5521999999999@c.us

Responses

/api/{session}/group-admins/{groupId}

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
groupId
required
string
Request Body schema: application/json
required
groupId
required
string

Responses

Request samples

Content type
application/json
{
  • "groupId": "<groupId>"
}

Get detailed information about a group

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
groupId
required
string
Example: <groupId>

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "response": {
    }
}

/api/{session}/group-invite-link/{groupId}

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
groupId
required
string
Request Body schema: application/json
required
groupId
string

Responses

Request samples

Content type
application/json
{
  • "groupId": "string"
}

/api/{session}/group-revoke-link/{groupId}

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
groupId
required
string
Request Body schema: application/json
required
$groupId
string

Responses

Request samples

Content type
application/json
{
  • "$groupId": "string"
}

/api/{session}/group-members-ids/{groupId}

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
groupId
required
string
Example: <groupId>

Responses

/api/{session}/create-group

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
participants
required
Array of strings
name
required
string

Responses

Request samples

Content type
application/json
{
  • "participants": [
    ],
  • "name": "Group name"
}

/api/{session}/leave-group

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
groupId
required
string

Responses

Request samples

Content type
application/json
{
  • "groupId": "string"
}

/api/{session}/join-code

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
inviteCode
required
string

Responses

Request samples

Content type
application/json
{
  • "inviteCode": "5644444"
}

/api/{session}/add-participant-group

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
groupId
required
string
phone
required
string

Responses

Request samples

Content type
application/json
{
  • "groupId": "<groupId>",
  • "phone": "5521999999999"
}

/api/{session}/remove-participant-group

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
groupId
required
string
phone
required
string

Responses

Request samples

Content type
application/json
{
  • "groupId": "<groupId>",
  • "phone": "5521999999999"
}

/api/{session}/promote-participant-group

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
groupId
required
string
phone
required
string

Responses

Request samples

Content type
application/json
{
  • "groupId": "<groupId>",
  • "phone": "5521999999999"
}

/api/{session}/demote-participant-group

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
groupId
required
string
phone
required
string

Responses

Request samples

Content type
application/json
{
  • "groupId": "<groupId>",
  • "phone": "5521999999999"
}

/api/{session}/group-info-from-invite-link

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
$invitecode
string

Responses

Request samples

Content type
application/json
{
  • "$invitecode": "string"
}

/api/{session}/group-description

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
$groupId
string
$description
string

Responses

Request samples

Content type
application/json
{
  • "$groupId": "string",
  • "$description": "string"
}

/api/{session}/group-property

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
$groupId
string
$property
string
$value
boolean

Responses

Request samples

Content type
application/json
{
  • "$groupId": "string",
  • "$property": "string",
  • "$value": true
}

/api/{session}/group-subject

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
$groupId
string
$title
string

Responses

Request samples

Content type
application/json
{
  • "$groupId": "string",
  • "$title": "string"
}

/api/{session}/messages-admins-only

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
$groupId
string
$value
boolean

Responses

Request samples

Content type
application/json
{
  • "$groupId": "string",
  • "$value": true
}

/api/{session}/group-pic

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
$groupId
string
$path
string

Responses

Request samples

Content type
application/json
{
  • "$groupId": "string",
  • "$path": "string"
}

/api/{session}/change-privacy-group

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
$groupId
string
$status
boolean

Responses

Request samples

Content type
application/json
{
  • "$groupId": "string",
  • "$status": true
}

Misc

Handles miscellaneous operations that do not fit into other specific categories.

/api/{session}/get-platform-from-message/{messageId}

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
messageId
required
string
Example: <messageId>

Responses

/api/{session}/{secretkey}/clear-session-data

path Parameters
session
required
string
Example: NERDWHATS_AMERICA
secretkey
required
string
Example: THISISMYSECURETOKEN

Responses

subscribePresence

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
string
isGroup
boolean
all
boolean

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "isGroup": false,
  • "all": false
}

setOnlinePresence

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
isOnline
boolean

Responses

Request samples

Content type
application/json
{
  • "isOnline": false
}

/api/{session}/all-broadcast-list

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA

Responses

/api/{session}/reject-call

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
callId
string

Responses

Request samples

Content type
application/json
{
  • "callId": "<callid>"
}

/api/{session}/check-number-status/{phone}

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
phone
required
string
Example: 5521999999999

Responses

/api/{session}/blocklist

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA

Responses

/api/{session}/block-contact

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
string
isGroup
boolean

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "isGroup": false
}

/api/{session}/unblock-contact

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
phone
string
isGroup
boolean

Responses

Request samples

Content type
application/json
{
  • "phone": "5521999999999",
  • "isGroup": false
}

/api/{session}/get-battery-level

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA

Responses

/api/{session}/host-device

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA

Responses

/api/{session}/get-phone-number

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA

Responses

Please, open the router in your browser, in swagge

Please, open the router in your browser, in swagger this not run

path Parameters
secretkey
required
string
Example: THISISMYSECURETOKEN

Responses

/api/{secretkey}/restore-sessions

path Parameters
secretkey
required
string
Example: THISISMYSECURETOKEN
Request Body schema: multipart/form-data
required
file
required
string <binary>

Responses

/api/{session}/take-screenshot

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA

Responses

Change limits of whatsapp web. Types value: maxMed

Change limits of whatsapp web. Types value: maxMediaSize, maxFileSize, maxShare, statusVideoMaxDuration, unlimitedPin;

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
type
required
string
value
required
any

Responses

Request samples

Content type
application/json
{
  • "type": "maxFileSize",
  • "value": 104857600
}

You can point your Chatwoot to this route so that

You can point your Chatwoot to this route so that it can perform functions.

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
Request Body schema: application/json
required
event
string
private
string

Responses

Request samples

Content type
application/json
{
  • "messageId": "conversation_status_changed",
  • "private": "false"
}

This endpoint can be used to check the health stat

This endpoint can be used to check the health status of the API. It returns a response with a status code indicating the API

Responses

This endpoint is used to force the API into an unh

This endpoint is used to force the API into an unhealthy state. It can be useful for testing error handling or simulating service disruptions.

Responses

This endpoint can be used to check the status of A

This endpoint can be used to check the status of API metrics. It returns a response with the collected metrics.

Responses

/api/{session}/all-contacts

path Parameters
session
required
string

Responses

createNewsletter

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
query Parameters
id
string
Example: id=<newsletter_id>
Request Body schema: application/json
required
name
string
description
string
picture
string

Responses

Request samples

Content type
application/json
Example
{
  • "name": "New name of channel",
  • "description": "New description of channel",
  • "picture": "<new_base64_image> or send null"
}

editNewsletter

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
id
required
string
Example: NEWSLETTER ID
Request Body schema: application/json
required
name
string
description
string
picture
string

Responses

Request samples

Content type
application/json
Example
{
  • "name": "New name of channel",
  • "description": "New description of channel",
  • "picture": "<new_base64_image> or send null"
}

destroyNewsletter

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
id
required
string
Example: NEWSLETTER ID

Responses

muteNewsletter

Authorizations:
bearerAuth
path Parameters
session
required
string
Example: NERDWHATS_AMERICA
id
required
string
Example: NEWSLETTER ID

Responses

/api-docs

Responses