Skip to main content
POST
/
sender
/
simple
Create new campaign (Simple)
curl --request POST \
  --url https://api.wppfy.com/sender/simple \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "numbers": [
    "5511999999999@s.whatsapp.net"
  ],
  "type": "text",
  "delayMin": 10,
  "delayMax": 30,
  "scheduled_for": 1706198400000,
  "info": "<string>",
  "delay": 123,
  "mentions": "<string>",
  "text": "<string>",
  "linkPreview": true,
  "linkPreviewTitle": "<string>",
  "linkPreviewDescription": "<string>",
  "linkPreviewImage": "<string>",
  "linkPreviewLarge": true,
  "file": "<string>",
  "docName": "<string>",
  "fullName": "<string>",
  "phoneNumber": "<string>",
  "organization": "<string>",
  "email": "<string>",
  "url": "<string>",
  "latitude": 123,
  "longitude": 123,
  "name": "<string>",
  "address": "<string>",
  "footerText": "<string>",
  "buttonText": "<string>",
  "listButton": "<string>",
  "selectableCount": 123,
  "choices": [
    "<string>"
  ],
  "imageButton": "<string>"
}
'
{
  "folder_id": "<string>",
  "count": 123,
  "status": "queued"
}

Authorizations

​
token
string
header
required

Body

application/json
​
numbers
string[]
required

List of numbers for sending

Example:
["5511999999999@s.whatsapp.net"]
​
type
enum<string>
required

Message type

Available options:
text,
image,
video,
audio,
document,
contact,
location,
list,
button,
poll,
carousel
​
delayMin
integer
required

Minimum delay between messages in seconds

Required range: x >= 1
Example:

10

​
delayMax
integer
required

Maximum delay between messages in seconds

Required range: x >= 1
Example:

30

​
scheduled_for
integer
required

Timestamp in milliseconds or minutes from now for scheduling

Example:

1706198400000

​
info
string

Additional information about the campaign

​
delay
integer

Fixed delay between messages (optional)

​
mentions
string

Mentions in the message in JSON format

​
text
string

Message text

​
linkPreview
boolean

Enable link preview in text messages. The preview will be automatically generated from the URL contained in the text.

​
linkPreviewTitle
string

Custom title for the link preview (optional)

​
linkPreviewDescription
string

Custom description for the link preview (optional)

​
linkPreviewImage
string

URL or base64 data of the image for the link preview (optional)

​
linkPreviewLarge
boolean

Whether to use large or small preview (optional, default false)

​
file
string

Media or file URL (when type is image, video, audio, document, etc.)

​
docName
string

Filename (when type is document)

​
fullName
string

Full name (when type is contact)

​
phoneNumber
string

Phone number (when type is contact)

​
organization
string

Organization (when type is contact)

​
email
string

Email (when type is contact)

​
url
string

URL (when type is contact)

​
latitude
number

Latitude (when type is location)

​
longitude
number

Longitude (when type is location)

​
name
string

Location name (when type is location)

​
address
string

Address (when type is location)

​
footerText
string

Footer text (when type is list, button, poll, or carousel)

​
buttonText
string

Button text (when type is list, button, poll, or carousel)

​
listButton
string

List button text (when type is list)

​
selectableCount
integer

Number of selectable options (when type is poll)

​
choices
string[]

List of choices (when type is list, button, poll, or carousel). For carousel, use specific format with [text], {image}, and buttons

​
imageButton
string

Image URL for the button (when type is button)

Response

Campaign created successfully

​
folder_id
string

Unique ID of the created campaign

​
count
integer

Number of scheduled messages

​
status
string

Operation status

Example:

"queued"