Skip to main content
POST
/
sender
/
advanced
Create advanced mass messaging
curl --request POST \
  --url https://api.wppfy.com/sender/advanced \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "delayMin": 3,
  "delayMax": 6,
  "info": "advanced test",
  "scheduled_for": 1,
  "messages": [
    {
      "number": "5511999999999",
      "type": "text",
      "text": "First message"
    },
    {
      "number": "5511999999999",
      "type": "button",
      "text": "Special Promotion!\nCheck out our amazing offers",
      "footerText": "Valid until 12/31/2024",
      "imageButton": "https://example.com/promo-banner.jpg",
      "choices": [
        "View Offers|https://store.example.com/offers",
        "Talk to Sales|reply:sales",
        "Copy Coupon|copy:PROMO2024"
      ]
    },
    {
      "number": "5511999999999",
      "type": "list",
      "text": "Choose your preferred category:",
      "listButton": "View Categories",
      "choices": [
        "[Electronics]",
        "Smartphones|electronics_smartphones",
        "Notebooks|electronics_notebooks",
        "[Clothing]",
        "T-shirts|clothing_tshirts",
        "Shoes|clothing_shoes"
      ]
    },
    {
      "number": "5511999999999",
      "type": "document",
      "file": "https://example.com/doc.pdf",
      "docName": "Document.pdf"
    },
    {
      "number": "5511999999999",
      "type": "carousel",
      "text": "Meet our products",
      "choices": [
        "[Smartphone XYZ\nThe most advanced smartphone in the line]",
        "{https://example.com/product1.jpg}",
        "Copy Code|copy:PROD123",
        "View on Site|https://example.com/xyz",
        "[Notebook ABC\nThe ideal notebook for professionals]",
        "{https://example.com/product2.jpg}",
        "Copy Code|copy:NOTE456",
        "Buy Online|https://example.com/abc"
      ]
    }
  ]
}
'
{
  "folder_id": "<string>",
  "count": 123,
  "status": "queued"
}

Authorizations

token
string
header
required

Body

application/json
messages
object[]
required

List of messages to be sent

delayMin
integer

Minimum delay between messages (seconds)

Required range: x >= 0
Example:

3

delayMax
integer

Maximum delay between messages (seconds)

Required range: x >= 0
Example:

6

info
string

Description or information about the mass messaging

Example:

"Launch campaign"

scheduled_for
integer

Timestamp in milliseconds (unix date) or minutes from now for scheduling

Example:

1

Response

Messages successfully added to the queue

folder_id
string

ID of the created folder/batch

count
integer

Total messages added to queue

status
string

Operation status

Example:

"queued"