Send newsletter invite link

post https://gate.whapi.cloud/newsletters/link/{NewsletterInviteCode}

Path Params

NewsletterInviteCode

string

required

Newsletter Invite Code

Body Params

Newsletter invite link

string

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.

quoted

string

Message ID of the message to be quoted

ephemeral

integer

1 to 604800

Time in seconds for the message to be deleted. The Disappearing messages setting should be enabled in the chat where you are sending this message.

edit

string

Message ID of the message to be edited

title

string

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

body

string

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

preview_type

string

Defaults to newsletter_picture

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.

preview

string

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

media

mime_type

string

Mime type of media

no_encode

boolean

Do not use our encoding

no_cache

boolean

Do not use the cache in a request

mentions

array of strings

The numbers of the mentioned users

mentions

view_once

boolean

Is view once

Responses

Response body

object

sent

boolean

required

Message sent

message

object

string

required

Message ID

type

string

required

Defaults to text

Message type

text image video gif audio voice short document documentWithCaption link_preview location live_location contact contact_list sticker system call unknown action group_invite newsletter_invite admin_invite product catalog interactive reply poll hsm order story event buttons list pin

subtype

string

Message subtype

chat_id

string

required

Chat ID

chat_name

string

Chat name

from

string

WhatsApp ID of the sender

from_me

boolean

required

Is message from me

from_name

string

Pushname of the sender

source

string

Defaults to text

Message source

web mobile api system business_api unknown

timestamp

number

required

Message timestamp

device_id

number

Device ID, if the message was not sent through the app

status

string

Message ack status

failed pending sent delivered read played deleted

text

object

image

object

video

object

short

object

gif

object

audio

object

voice

object

document

object

link_preview

object

If 'body' contains a link, this props can be used to create custom preview link

sticker

object

location

object

live_location

object

contact

object

contact_list

object

interactive

object

poll

object

hsm

object

system

object

order

object

group_invite

object

If 'body' contains a link, this props can be used to create custom preview link

newsletter_invite

object

If 'body' contains a link, this props can be used to create custom preview link

admin_invite

object

product

object

catalog

object

If 'body' contains a link, this props can be used to create custom preview link

product_items

object

action

object

context

object

event

object

list

object

buttons

object

reactions

array of objects

Reactions for message

reactions

object

string

Reaction ID

emoji

string

required

Reaction text

group_key

string

Reaction group key

number

Reaction timestamp

unread

boolean

Is reaction unread

count

number

Reaction count

labels

array of objects

Labels associated with message

labels

object

string

required

Label ID

name

string

required

Label name

color

string

required

Label color

salmon lightskyblue gold plum silver mediumturquoise violet goldenrod cornflowerblue greenyellow cyan lightpink mediumaquamarine orangered deepskyblue limegreen darkorange lightsteelblue mediumpurple rebeccapurple

count

int32

≥ 0

Number of objects associated with this label

Language

Credentials

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://gate.whapi.cloud/newsletters/link/ \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "preview_type": "newsletter_picture"
8
}
9
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Created

400Wrong request parameters

401Need channel authorization for this action

404Specified newsletter not found

429Too many requests

500Internal Error