Skip to main content
POST
/
api
/
{session}
/
channels
Create a new channel
curl --request POST \
  --url https://{host}/api/{session}/channels \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "name": "Channel Name",
  "description": "Channel Description",
  "picture": {
    "mimetype": "image/jpeg",
    "url": "https://github.com/stgcompany/wappfy/raw/core/examples/wappfy.jpg",
    "filename": "filename.jpg"
  }
}
'
{
  "name": "My Channel",
  "description": "News and updates channel",
  "picture": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="
}

​
Description

This endpoint allows you to create a new channel on WhatsApp. Channels are resources that allow broadcasting messages to a large number of followers in a unidirectional way.

​
URL Parameters

​
session
string
required
WhatsApp unique authenticated session ID

​
Request Body

​
name
string
required
Name of the channel to be created
​
description
string
required
Description of the channel that will appear to followers
​
picture
string
Image of the channel encoded in base64 (optional)

​
Response

​
success
boolean
Indicates if the channel was created successfully
{
  "name": "My Channel",
  "description": "News and updates channel",
  "picture": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="
}

​
Status Codes

  • 200 - Channel created successfully
  • 400 - Invalid or missing parameters
  • 401 - Unauthorized
  • 500 - Internal server error

​
Usage Example

curl -X POST https://api.wappfy.com.br/api/my-session/channels \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Channel",
    "description": "News and updates channel",
    "picture": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="
  }'

Authorizations

​
apikey
string
header
required

Your Wappfy API key (get it at dash.wappfy.com.br)

Path Parameters

​
session
string
required

Session name (instanceName)

Body

application/json
​
name
string
required
Example:

"Channel Name"

​
description
string
Example:

"Channel Description"

​
picture
object

Response

201 - application/json
​
id
string
required

Newsletter id

Example:

"123123123123@newsletter"

​
name
string
required

Channel name

Example:

"Channel Name"

​
invite
string
required

Invite link

Example:

"https://www.whatsapp.com/channel/111111111111111111111111"

​
role
enum<string>
required
Available options:
OWNER,
ADMIN,
SUBSCRIBER,
GUEST
​
verified
boolean
required
​
subscribersCount
number
required
​
preview
string

Preview for channel's picture

Example:

"https://mmg.whatsapp.net/m1/v/t24/An&_nc_cat=10"

​
picture
string

Channel's picture

Example:

"https://mmg.whatsapp.net/m1/v/t24/An&_nc_cat=10"

​
description
string