Whats App

Node: whatsApp · Full type: n8n-nodes-base.whatsApp · Version: 1.1

Credentials

whatsAppApi (alias: @whats)

CREDENTIAL @whats = whatsAppApi "My Whats App"

Operations

Resource: message

send

Parameter	Type	Default	Details
messageType	options	"text"	audio, contacts, document, image, location, text, video
longitude	number	""	required
latitude	number	""	required
additionalFields	fixedCollection	{}	groups: nameAndAddress
textBody	string	""	required
additionalFields	collection	{}	keys: mediaFilename, mediaCaption
additionalFields	collection	{}	keys: previewUrl

sendAndWait

Parameter	Type	Default	Details
message	string	""	required
responseType	options	"approval"	approval, freeText, customForm
defineForm	options	"fields"	fields, json
jsonOutput	json	"[
{
"fieldLabel": "Name",
"..."
formFields	fixedCollection	{}	groups: values
formFields	fixedCollection	{}	groups: values
approvalOptions	fixedCollection	{}	groups: values
options	collection	{}	keys: limitWaitTime, appendAttribution
options	collection	{}	keys: messageButtonLabel, responseFormTitle, responseFormDescription, responseFormButtonLabel, responseFormCustomCss, limitWaitTime, ...

sendTemplate

Parameter	Type	Default	Details
template	options	""	required
components	fixedCollection	{}	groups: component

Resource: media

mediaUpload

Parameter	Type	Default	Details
phoneNumberId	options	""	required
mediaPropertyName	string	"data"	required
additionalFields	collection	{}	keys: mediaFileName

mediaUrlGet

Parameter	Type	Default	Details
mediaGetId	string	""	required

mediaDelete

Parameter	Type	Default	Details
mediaDeleteId	string	""	required

Common Parameters

Parameter	Type	Default	Details
phoneNumberId	options	""	required
recipientPhoneNumber	string	""	required

Parameter Details

additionalFields children:

nameAndAddress group:

Parameter	Type	Default	Details
name	string	""
address	string	""

name children:

data group:

Parameter	Type	Default	Details
formatted_name	string	""	required
first_name	string	""
last_name	string	""
middle_name	string	""
suffix	string	""
prefix	string	""

components children:

component group:

Parameter	Type	Default	Details
type	options	"body"	body, button, header
bodyParameters	fixedCollection	{}	groups: parameter
sub_type	options	"quick_reply"	quick_reply, url
index	number	0
buttonParameters	fixedCollection	{}	groups: parameter
headerParameters	fixedCollection	{}	groups: parameter

formFields children:

values group:

Parameter	Type	Default	Details
fieldName	string	""	required
fieldLabel	string	""	required
fieldLabel	string	""	required
fieldName	string	""
fieldType	options	"text"	required; checkbox, html, date, dropdown, email, file, hiddenField, number, ... (12 total)
elementName	string	""
fieldName	string	""
placeholder	string	""
defaultValue	string	""
defaultValue	dateTime	""
defaultValue	string	""
defaultValue	string	""
fieldValue	string	""
fieldOptions	fixedCollection	{...}	required; groups: values
fieldOptions	fixedCollection	{...}	required; groups: values
fieldOptions	fixedCollection	{...}	required; groups: values
multiselect	boolean	false
limitSelection	options	"unlimited"	exact, range, unlimited
numberOfSelections	number	1
minSelections	number	0
maxSelections	number	1
html	string	"

" | | | multipleFiles | boolean | true | | | acceptFileTypes | string | "" | | | requiredField | boolean | false | |

approvalOptions children:

values group:

Parameter	Type	Default	Details
approvalType	options	"single"	single, double
approveLabel	string	"✓ Approve"
disapproveLabel	string	"✗ Decline"

options children:

Parameter	Type	Default	Details
limitWaitTime	fixedCollection	{...}	groups: values
appendAttribution	boolean	true

Example

NODE "whatsApp" @whats AS "Whats App" {
  resource: "message",
  operation: "send",
  recipientPhoneNumber: {{ $json.recipientPhoneNumber }},
  longitude: 0,
  latitude: 0
}