Sign in
Newsletters

Send newsletter invite link

Read more about how to get an invite code.

post/newsletters/link/{NewsletterInviteCode}

Path parameters

NewsletterInviteCodestring required

Newsletter Invite code

Newsletter Invite Code

Request body

tostring required

Use the phone number or Chat ID of the contact/group/channel to which you want to send the message. Use Get groups to get the group ID.

quotedstring

Message ID of the message to be quoted

editstring

Message ID of the message to be edited

titlestring

Title of the newsletter. If not set, the newsletter title will be used

bodystring

Invite message with link. Example: "Follow this link to join my newsletter on WhatsApp". Use %URL% to insert the invite link.

preview_type'newsletter_picture' | 'thumbnail' | 'media' | 'style1' | 'style2' | 'style3' | 'none'

Type of the newsletter preview. Use 'newsletter_picture' to set a newsletter picture as large preview, 'thumbnail' to set a custom small jpeg image from 'preview' param as preview, 'media' to set a custom large image from 'media' param as large preview, 'style1' to set a isometric style for newsletter invite link preview stub, 'style2' to set a flat style for newsletter invite link preview stub, 'style3' to set a WA style for newsletter invite link preview stub, or 'none' to not set a preview. If not set, the default is newsletter_picture.

previewstring

Base64 encoded image for small version newsletter invite link preview (preview_type=thumbnail). In JPEG format

mime_typestring

Mime type of media

no_encodeboolean

Do not use our encoding

no_cacheboolean

Do not use the cache in a request

mentionsstring[]

The numbers of the mentioned users

Example request

{
  "to": "1234567891@s.whatsapp.net"
}

Response

Created

sentboolean required

Message sent

Changes