Before you can use the API, you need to make sure you have an active subscription. If you want to test the API, there’s a free plan with restricted access that requires approval. You can get access by telling us about your use case, and we’ll be happy to let you try it.

Once subscribed, these are the steps you need to take to start using the API:

SIGN-UP and LINK

1. If this is your first time using the API, navigate to the sign-up category and use the endpoint to create an instance. This step is only necessary upon initial subscription; as long as you remain subscribed, this instance will be associated with your rapidapi username, and you wont need to create a new instance again.

2. Once the instance is created, you should proceed to the instance operations category.

3. The /enrol endpoint will generate a QR code that you must scan with the whatsapp mobile phone app to link the WhatsApp account to the API instance.

4. At any time, you can use the /status endpoint to display the status of the instance, indicating whether it is connected to the WhatsApp Network, or not.

5. Use the /unenrol endpoint if you want the instance to disconnect from the WhatsApp Network. Calling this endpoint is equivalent to unlinking the instance device from the WhatsApp account via the mobile app.

CHANNEL OPERATION

The operations that you can perform through the API are as follows:

1. Creating a channel: To create a channel, you should use the endpoint named create channel and input data such as the subject or the profile picture of the channel you wish to create.

2. Obtaining metadata of a channel you have created: The get channel metadata endpoint will return metadata of a created channel, and includes on the response things like the creation date, the invitation link to follow the channel, the channel title, among other things.

3. Sending newsletters to WhatsApp channels where you have writing rights: Newsletters are the communications that you send on the whatsapp channel; they can be texts, images, videos, etc. You can find an example of the different types of messages in the API documentation, or on the send newsletter endpoint examples through the rapidapi playground.

Here is a link to a video with a step by step guide: