/
WP
wppconnect-team
/
WPPConnect API Rest
Search skmtc…
⌘K
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Subscribe
v1
latest
OpenAPI 3.0.0
2026-07-17
156
1
205.9 KB
Auth
post
/api/{session}/{secretkey}/generate-token
Path parameters
session
string
required
Example:
NERDWHATS_AMERICA
secretkey
string
required
Example:
THISISMYSECURETOKEN
Response
Created
All 156 operations
post
/api/{session}/{secretkey}/generate-token
get
/api/{secretkey}/show-all-sessions
post
/api/{secretkey}/start-all
get
/api/{session}/check-connection-session
get
/api/{session}/get-media-by-message/{messageId}
get
/api/{session}/get-platform-from-message/{messageId}
get
/api/{session}/qrcode-session
post
/api/{session}/start-session
post
/api/{session}/logout-session
post
/api/{session}/{secretkey}/clear-session-data
post
/api/{session}/close-session
post
/api/{session}/subscribe-presence
post
/api/{session}/set-online-presence
post
/api/{session}/download-media
post
/api/{session}/send-message
post
/api/{session}/edit-message
post
/api/{session}/send-image
post
/api/{session}/send-sticker
post
/api/{session}/send-sticker-gif
post
/api/{session}/send-reply
post
/api/{session}/send-file
post
/api/{session}/send-file-base64
post
/api/{session}/send-voice
post
/api/{session}/send-voice-base64
get
/api/{session}/status-session
post
/api/{session}/send-status
post
/api/{session}/send-link-preview
post
/api/{session}/send-location
post
/api/{session}/send-mentioned
post
/api/{session}/send-buttons
post
/api/{session}/send-list-message
post
/api/{session}/send-order-message
post
/api/{session}/send-poll-message
post
/api/{session}/send-pix-key
get
/api/{session}/all-broadcast-list
get
Deprecated in favor of
get
/api/{session}/group-members/{groupId}
get
/api/{session}/common-groups/{wid}
get
/api/{session}/group-admins/{groupId}
get
Get detailed information about a group
get
/api/{session}/group-invite-link/{groupId}
get
/api/{session}/group-revoke-link/{groupId}
get
/api/{session}/group-members-ids/{groupId}
post
/api/{session}/create-group
post
/api/{session}/leave-group
post
/api/{session}/join-code
post
/api/{session}/add-participant-group
post
/api/{session}/remove-participant-group
post
/api/{session}/promote-participant-group
post
/api/{session}/demote-participant-group
post
/api/{session}/group-info-from-invite-link
post
/api/{session}/group-description
post
/api/{session}/group-property
post
/api/{session}/group-subject
post
/api/{session}/messages-admins-only
post
/api/{session}/group-pic
post
/api/{session}/change-privacy-group
get
Deprecated in favor of
post
Retrieve a list of chats
get
/api/{session}/all-chats-archived
get
Deprecated in favor of list-chats
get
/api/{session}/all-messages-in-chat/{phone}
get
/api/{session}/all-new-messages
get
/api/{session}/unread-messages
get
/api/{session}/all-unread-messages
get
/api/{session}/chat-by-id/{phone}
get
/api/{session}/message-by-id/{messageId}
get
/api/{session}/chat-is-online/{phone}
get
/api/{session}/last-seen/{phone}
get
/api/{session}/list-mutes/{type}
get
/api/{session}/load-messages-in-chat/{phone}
get
/api/{session}/get-messages/{phone}
post
/api/{session}/archive-chat
post
/api/{session}/archive-all-chats
post
/api/{session}/clear-chat
post
/api/{session}/clear-all-chats
post
/api/{session}/delete-chat
post
/api/{session}/delete-all-chats
post
/api/{session}/delete-message
post
/api/{session}/react-message
post
/api/{session}/forward-messages
post
/api/{session}/mark-unseen
post
/api/{session}/pin-chat
post
/api/{session}/contact-vcard
post
/api/{session}/send-mute
post
/api/{session}/send-seen
post
/api/{session}/chat-state
post
/api/{session}/temporary-messages
post
/api/{session}/typing
post
/api/{session}/recording
post
/api/{session}/star-message
get
/api/{session}/reactions/{id}
get
/api/{session}/votes/{id}
post
/api/{session}/reject-call
get
/api/{session}/get-products
get
/api/{session}/get-product-by-id
post
/api/{session}/add-product
post
/api/{session}/edit-product
post
/api/{session}/del-products
post
/api/{session}/change-product-image
post
/api/{session}/add-product-image
post
/api/{session}/remove-product-image
get
/api/{session}/get-collections
post
/api/{session}/create-collection
post
/api/{session}/edit-collection
post
/api/{session}/del-collection
post
/api/{session}/send-link-catalog
post
/api/{session}/set-product-visibility
post
/api/{session}/set-cart-enabled
post
/api/{session}/send-text-storie
post
/api/{session}/send-image-storie
post
/api/{session}/send-video-storie
post
/api/{session}/add-new-label
post
/api/{session}/add-or-remove-label
get
/api/{session}/get-all-labels
put
/api/{session}/delete-all-labels
put
/api/{session}/delete-label/{id}
get
/api/{session}/check-number-status/{phone}
get
/api/{session}/all-contacts
get
/api/{session}/contact/{phone}
get
/api/{session}/contact/pn-lid/{pnLid}
get
/api/{session}/profile/{phone}
get
/api/{session}/profile-pic/{phone}
get
/api/{session}/profile-status/{phone}
get
/api/{session}/blocklist
post
/api/{session}/block-contact
post
/api/{session}/unblock-contact
get
/api/{session}/get-battery-level
get
/api/{session}/host-device
get
/api/{session}/get-phone-number
post
/api/{session}/set-profile-pic
post
/api/{session}/profile-status
post
/api/{session}/change-username
post
/api/{session}/edit-business-profile
get
/api/{session}/get-business-profiles-products
get
/api/{session}/get-order-by-messageId/{messageId}
get
/api/{secretkey}/backup-sessions
post
/api/{secretkey}/restore-sessions
get
/api/{session}/take-screenshot
post
/api/{session}/set-limit
post
/api/{session}/create-community
post
/api/{session}/deactivate-community
post
/api/{session}/add-community-subgroup
post
/api/{session}/remove-community-subgroup
post
/api/{session}/promote-community-participant
post
/api/{session}/demote-community-participant
get
/api/{session}/community-participants/{id}
post
/api/{session}/newsletter
put
/api/{session}/newsletter/{id}
delete
/api/{session}/newsletter/{id}
post
/api/{session}/mute-newsletter/{id}
post
/api/{session}/chatwoot
get
/api-docs
get
/healthz
get
/unhealthy
get
/metrics