BatZapDevelopersPortuguêsGet an API key

    Getting started

    OverviewQuickstartAuthenticationScopesRate limitsErrorsMCP server

    Account

    GETHealth checkGETList integrations

    Conversations

    GETList conversationsGETList a member's conversationsPOSTChange conversation statusPOSTResolve a conversationPATCHAssign a conversationPOSTTag a conversationDELUntag a conversationPOSTAdd a private note

    Messages & contacts

    GETList a contact's messagesGETList a group's messagesGETGet message mediaGETGet a media download URLPATCHUpdate a contact

    Sending

    POSTSend a messagePOSTUpload mediaPUTEdit a messagePOSTStart a conversation

    Tags

    GETList tagsGETGet a tagPOSTCreate a tagPUTUpdate a tagDELDelete a tag

    Groups

    GETGet group detailsGETGet group invite linkPOSTCreate a groupPOSTInvite people to a groupPOSTManage participantsPOSTRename a groupPOSTChange group descriptionPOSTChange group picture
    API v1

    BatZap Developer Hub

    Everything you need to plug your systems and AI assistants into your WhatsApp team inbox: conversations, messages, tags, assignment and groups.

    Get started Create an API key
    List open conversations
    curl "https://api.batzap.com/v1/chats?status=open&limit=20" \
      -H "Authorization: bzp_live_YOUR_API_KEY"

    Quickstart

    Create an API key and send your first request in under five minutes.

    Get started

    API Reference

    Every endpoint with its parameters, scopes and ready-to-paste examples.

    Explore the API

    MCP server

    Connect Claude, Cursor and other AI assistants straight to your WhatsApp inbox.

    Connect an assistant

    API Reference overview

    32 endpoints under https://api.batzap.com/v1.

    Account2Check your key and list the WhatsApp numbers it can use.Conversations8List, filter, assign, tag, annotate and resolve conversations.Messages & contacts5Read message history, fetch media and update contact details.Sending4Send text, media, polls and contacts, reply, edit, and start new conversations.Tags5Create and manage the labels your team uses for triage.Groups8Create WhatsApp groups, invite people, manage participants and settings.

    The basics

    Authentication

    API keys and the Authorization header.

    Scopes

    What each permission unlocks.

    Rate limits

    Per-key budgets for reads, writes and sends.

    Errors

    Status codes and the error body.