Show more

Use to navigate results, ENTER to select one, ESC to close

Type in any word to easily find the endpoint, property or group of operations you are looking for.

API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Go Whatsapp Multi Session REST API

Topics

  • Introduction
  • Authentication

Endpoints

  • 00 - Health
    • Server Status GET
  • 01 - Documentation
    • OpenAPI Specification (JSON) GET
    • OpenAPI Specification (YAML) GET
    • Swagger UI GET
  • 02 - Admin
    • Get Admin Statistics GET
    • Get System Health GET
    • Get WhatsApp Web Version GET
    • Refresh WhatsApp Web Version POST
    • List All Devices GET
    • Get All Device Statuses GET
    • Reconnect All Devices POST
    • Get Webhook Statistics GET
    • List All API Keys GET
    • Create API Key POST
    • Get API Key Details GET
    • Delete API Key DELETE
    • Update API Key PATCH
    • List Devices by API Key GET
    • Get Device Statuses by API Key GET
    • Delete Device (Admin) DELETE
  • 03 - Device Registration
    • Create Device POST
    • Regenerate JWT Token POST
  • 04 - Device Operations
    • Get Current Device Info GET
    • Get Device Connection Status GET
    • Login with QR Code POST
    • Login with Pairing Code POST
    • Reconnect Device POST
    • Logout Device DELETE
    • Get Device Proxy Configuration GET
    • Set Device Proxy Configuration POST
    • Register for Push Notifications POST
    • Check WhatsApp Registration GET
    • Set Passive Mode POST
  • 05 - User Management
    • Get User Info GET
    • Get Profile Picture GET
    • Block User POST
    • Unblock User DELETE
    • Get Privacy Settings GET
    • Update Privacy Settings PATCH
    • Get Status Privacy GET
    • Update About Status POST
    • Get User's Linked Devices GET
    • Set Profile Photo POST
    • Get Contacts GET
    • Sync Contacts POST
    • Get Blocklist GET
  • 06 - Messaging
    • Get Chat Messages GET
    • Send Text Message POST
    • Send Image POST
    • Send Document POST
    • Archive/Unarchive Chat POST
    • Pin/Unpin Chat POST
    • Send Video POST
    • Send Audio POST
    • Send Sticker POST
    • Send Location POST
    • Send Contact POST
  • 07 - Message Actions
    • Mark Message as Read POST
    • React to Message POST
    • Delete Message DELETE
    • Edit Message PATCH
    • Reply to Message POST
    • Forward Message POST
    • Send Media Retry Receipt POST
  • 08 - Group Management
    • List All Groups With Members GET
    • Create Group POST
    • Get Group Info GET
    • Leave Group POST
    • Update Group Name PATCH
    • Update Group Description PATCH
    • Update Group Photo POST
    • Get Invite Link GET
    • Update Group Settings PATCH
    • Add Participants POST
    • Remove Participants DELETE
    • Promote to Admin POST
    • Demote from Admin DELETE
    • Get Join Requests GET
    • Approve Join Requests POST
    • Reject Join Requests POST
    • Set Join Approval Mode POST
    • Get Info from Invite Link GET
    • Join via Invite POST
    • Set Member Add Mode PATCH
    • Update Group Topic PATCH
    • Link Subgroup POST
    • Get Community Members GET
    • List Subgroups GET
    • Unlink Subgroup from Community DELETE
  • 09 - Presence & Status
    • Send Typing/Recording Indicator POST
    • Set Online/Offline Status POST
    • Set Disappearing Messages Timer PATCH
    • Subscribe to Presence Updates POST
  • 10 - App State
    • Fetch App State GET
    • Send App State Patch POST
    • Mark App State as Clean POST
  • 11 - Webhooks
    • List Webhooks GET
    • Create Webhook POST
    • Get Webhook Details GET
    • Delete Webhook DELETE
    • Update Webhook PATCH
    • Get Webhook Logs GET
    • Test Webhook POST
  • 12 - Polls
    • Create Poll POST
    • Vote on Poll POST
    • Get Poll Results GET
    • Delete Poll DELETE
  • 13 - Newsletter/Channels
    • List Subscribed Newsletters GET
    • Create Newsletter POST
    • Get Newsletter Info GET
    • Follow Newsletter POST
    • Unfollow Newsletter DELETE
    • Get Newsletter Messages GET
    • Send Newsletter Message POST
    • React to Newsletter Message POST
    • Toggle Newsletter Mute POST
    • Mark Newsletter Messages Viewed POST
    • Get Newsletter Info from Invite GET
    • Subscribe to Live Updates POST
    • Update Newsletter Photo POST
    • Get Newsletter Message Updates GET
    • Accept TOS Notice POST
  • 14 - Status/Stories
    • Get Status Updates GET
    • Post Status POST
    • Delete Status DELETE
    • Get User Status GET
  • 15 - Calls
    • Reject Incoming Call POST
  • 16 - Business
    • Get Business Profile GET
    • Resolve Business Message Link GET
  • 17 - Bots
    • Get Available Bots GET
    • Get Bot Profiles GET
  • 18 - Contact QR
    • Get Contact QR Link GET
    • Resolve Contact QR Link GET
  • 19 - History Sync
    • Build History Sync Request POST
Powered by Bump.sh
API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Go Whatsapp Multi Session REST API

00 - Health

Ask AI
  • Open in ChatGPT
  • Open in Claude

  • View as Markdown
  • Copy as Markdown

Server status and health check