v1

latestOpenAPI 3.0.02026-07-14181255304.7 KB

Newsletters

Edit newsletter

This method is responsible for editing a WhatsApp Newsletter Channel

patch/newsletters/{NewsletterID}

Path parameters

NewsletterIDstring required

Newsletter ID

Request body

namestring

descriptionstring

newsletter_picstring

Newsletter jpeg picture in base64 format

reactions'all' | 'basic' | 'blocklist' | 'none'

Available reactions

Example request

{
  "name": "<Newsletter Title>",
  "description": "<Newsletter Description>",
  "newsletter_pic": "<data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAAAAAAAD/>"
}

Response

idstring required

Chat ID

phonestring

Phone number

namestring required

Newsletter name

Chat type

timestampinteger

Chat timestamp

chat_picstring

Chat picture URL

chat_pic_fullstring

Chat full picture URL

pinboolean

Is chat pinned

muteboolean

Is chat muted

mute_untilinteger

Chat mute until

archiveboolean

Is chat archived

unreadinteger

Unread messages count

unread_mentionboolean

Is chat unread mention

read_onlyboolean

Is chat read only

not_spamboolean

Is chat not spam

name_atinteger

Newsletter name change timestamp

descriptionstring

Newsletter description

description_atstring

Newsletter description change timestamp

subscribers_countinteger

Newsletter subscribers count

created_atinteger

Newsletter creation timestamp

invite_codestring

Newsletter invite code

handlestring

Newsletter handle

verificationboolean

Is newsletter verified

previewstring

Newsletter preview URL

role'subscriber' | 'admin' | 'guest' | 'owner'

User's role regarding the newsletter