📢 Channels

Create a new channel.

post/api/{session}/channels

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/api/{session}/channels
  • Auth: API key in header X-Api-Key

Path parameters

sessionstring required

Session name

Request body

namestring required
descriptionstring

Example request

{
  "name": "Channel Name",
  "description": "Channel Description",
  "picture": {
    "mimetype": "image/jpeg",
    "filename": "filename.jpg",
    "url": "https://picsum.photos/1024"
  }
}

Response

idstring required

Newsletter id

namestring required

Channel name

invitestring required

Invite link

previewstring

Preview for channel's picture

picturestring

Channel's picture

role'OWNER' | 'ADMIN' | 'SUBSCRIBER' | 'GUEST' required
descriptionstring
verifiedboolean required
subscribersCountnumber required

Example response

{
  "id": "123123123123@newsletter",
  "name": "Channel Name",
  "invite": "https://www.whatsapp.com/channel/111111111111111111111111",
  "preview": "https://mmg.whatsapp.net/m1/v/t24/An&_nc_cat=10",
  "picture": "https://mmg.whatsapp.net/m1/v/t24/An&_nc_cat=10"
}

Changes