Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

​
What is RyzeAPI

RyzeAPI is a REST gateway that turns WhatsApp into a modern API, letting systems, CRMs, bots, automations, and dashboards send and receive messages, manage groups, publish to channels, and react to events in real time, without having to deal with the complexity of WhatsApp Web’s internal protocol. You send an HTTP request, RyzeAPI handles the rest.

Messages in any format

Text, media, stickers, location, contacts, reactions, polls, carousels, lists, buttons, forms, and even PIX.

Multiple instances per account

Manage multiple WhatsApp numbers simultaneously, each with its own token and isolated settings.

Real-time events

Receive messages, delivery status, and group changes via webhook or WebSocket. Up to 3 simultaneous webhooks per instance.

Advanced native features

Carousels, interactive buttons, lists, forms, and PIX buttons, features that are normally unavailable in generic WhatsApp APIs.

​
What you can do

RyzeAPI covers the full WhatsApp integration lifecycle:
  • 1-to-1 and group conversations, send and receive any kind of content
  • Contact management, list, organize with labels, block, favorite
  • Groups, create, invite, moderate, update name/description/photo, manage participants
  • Communities, create communities and link your groups
  • Newsletters (channels), broadcast to followers
  • Account profile, name, photo, privacy
  • Stories (status), publish status posts that disappear in 24h
  • Live events, webhooks and WebSockets to react in real time

​
Architecture of your integration

Understanding these 3 levels helps you design your application correctly:
1

Your account (Account)

Your space on RyzeAPI. Has a unique TokenAccount and a limit on how many instances you can create.
2

Your instances (Instance)

Each instance is an active connection to a WhatsApp number. One account can have several, for example one for sales, another for support, another for marketing.Each instance receives its own TokenInstance when created.
3

Your day-to-day operations

Use the TokenInstance. Sending messages, reading contacts, creating groups, configuring webhooks, everything goes through the specific instance’s token.

​
Getting started

Quickstart

Connect your WhatsApp and send your first message in less than 5 minutes.

Concepts

Understand the core concepts before diving into the endpoints.

Authentication

How to use TokenAccount and TokenInstance.

Error types

Response formats and how to handle each HTTP code.

​
Explore the modules

The API is organized into modules. Each one groups endpoints that handle a specific aspect of WhatsApp.

Instance

Create, connect, disconnect, adjust settings.

Messages

Send all types: text, media, buttons, carousels, lists.

Chat

Contacts, labels, archive, pin, edit, delete messages.

Groups

Create groups, manage participants, invite links.

Communities

Create communities and link your groups.

Newsletter

Create and manage broadcast channels.

Profile

Name, photo, and privacy of the WhatsApp account.

Events

Configure webhooks and WebSockets per instance.

WebSocket

Persistent connection for real-time events.

Chatwoot

Integration with Chatwoot via the RyzeIntegrations bridge.