QuickReply.ai Official Documentation
  • Introduction
    • QuickReply.ai
  • Getting Started
    • Installation
      • Install QuickReply on Shopify Store
  • Drip Campaigns
    • Drip Campaigns by QuickReply.ai
  • Templates Guide
    • Creating a standard template for WhatsApp
    • Creating a carousel template for WhatsApp
  • Broadcasts Guide
    • Creating a Broadcast
    • Creating a Broadcast using Carousel Template
    • Broadcasts Reports
    • Recover failed messages in a WhatsApp broadcast
      • How does Smart Utility Fallback Work?
  • Click-to-WhatsApp Ads
  • Two-Factor Authentication Guide
  • Uninstallation / Migration
    • Migrating from WhatApp Business API to WhatApp Mobile Apps
  • Customer profies
    • Export Customer Profiles
  • API Documentaion
    • Sync Contacts to CRM API
    • WhatsApp Chat API
    • Send Template API
    • Trigger Drip Campaign API
    • External CRM Integration
    • Fetch Campaign Messages Stats
    • Browse Abandoned Recovery Integrations
  • WhatsApp Green Tick
    • How to get a Green Tick on your WhatsApp number
  • Analytics
    • Order and Revenue Attribution
    • Google Analytics Report
  • Miscellaneous
    • Types of WhatsApp Messages
    • Quality Ratings & Messaging Limits
    • FAQs
    • Account health and blocking
    • What formats of media / image / video or audio are supported on WhatsApp Business API?
  • Segments Guide
    • Customer Segments
      • Customer Segment Filters
  • WhatsApp Display Name & WhatsApp Profile
    • WhatsApp Display Name
  • Customizations
    • Notifications
  • How to
    • Subscribe to push notifications on browser
    • Enable/Disable different notifications for agents
    • Unblock notifications permission
    • Install QuickReply on Mobile
  • Miscellaneous
    • QuickReply.ai - Data privacy and security
  • Message Template Guidelines
  • Video Tutorials on WhatsApp for E-commerce
  • Quality Ratings and Messaging Limits of WhatsApp Business API
  • Phone number requirements, Business Profile & Migration
  • Phone number and profile Messaging Limits FAQs
  • How to enable Facebook Business verification option
  • How to get Facebook Business Manager verified
  • Language Supported
  • Trusted Domains
  • Integration
  • Chat Widget
  • Channels
  • Team
  • How to Collect WhatsApp Business Opt-Ins for your Shopify Store?
  • FAQ Training
  • Keyword Training
  • How to export leads captured on chat by QuickReply.ai?
  • Merge Fields for WhatsApp Campaigns
  • How to send WhatsApp message using REST API - QuickReply.ai
  • How to share Facebook Business Manager Access to QuickReply.ai
  • What are the media file size limits and aspect ratio in WhatsApp Business API?
  • FAQ Training
  • How to integrate Razorpay for COD-to-Prepaid WhatsApp Campaigns?
  • How to integrate CashFree for COD-to-Prepaid WhatsApp Campaigns?
  • How to integrate PayU for COD-to-Prepaid WhatsApp Campaigns?
  • INTEGRATION
    • Social
      • Instagram DM & Messenger
        • Link Facebook page to Instagram account
        • Enable "Allow access to messages" for Instagram DM
    • Analytics
      • Meta Pixel
      • Google Analytics 4 (GA4)
    • CRM
      • HubSpot CRM
      • Zoho CRM
      • LeadSquared CRM
      • Salesforce
        • How to Enable WhatsApp Chat in Salesforce
        • How to Automatically Create Leads from New Chats and Get Notifications in Salesforce
    • CDP
      • MoEngage
  • FLASH RESPONSES
    • Flash Responses
    • Create Flash Response
    • Using Flash Response
  • FAQs
    • FAQ list
      • WhatsApp Messenger
        • "This business is now working to manage this chat", what does this mean?
      • Media
        • How can I send images as an album in WhatsApp Business API?
      • Blocking/ Unblocking
        • Can I reject or block incoming messages to my WhatsApp number on QuickReply.ai?
        • How to block an end-user from sending and receiving messages from your WhatsApp number?
        • Can users block or report WhatsApp Business API number?
Powered by GitBook
On this page
  • Trigger Drip Campaign API
  • Send WhatsApp Custom Campaign Message by API

Was this helpful?

  1. API Documentaion

Trigger Drip Campaign API

This page introduces the Send WhatsApp Campaign API from QuickReply.ai, a powerful tool designed to enhance your marketing efforts by enabling you to send or schedule messages directly to your custom Whether you're looking to trigger a time-sensitive offer, a reminder for an event, or a drip campaign to engage your audience, this API simplifies the process. By leveraging this API, you ensure that your message reaches your audience at the right time, every time. With prerequisites including an approved template, sufficient wallet balance, and adherence to daily messaging limits, this API is ready to elevate your marketing strategy on WhatsApp.

Trigger Drip Campaign API

This API helps you to send/ schedule a message to the end-user using an API.

This API requires an active WhatsApp Account on QuickReply.ai along with a non-negative WhatsApp Wallet Balance

Pre-requisites

  • The WhatsApp Template is already approved

  • You have Messaging Credits Wallet balance to send the template message

  • You have not exceeded your daily messaging limit on your WhatsApp number

Send WhatsApp Custom Campaign Message by API

POST https://app.quickreply.ai/api/campaign/{{campaign_id}}/event

The body is a JSON Object

Query Parameters

Name
Type
Description

campaign_id*

String

You can find the Campaign ID by clicking on the 3 dots at the right of the Campaigns block and clicking "Copy Campaign Id"

Headers

Name
Type
Description

client-id*

String

secret-key*

String

Content-Type*

String

application/json

Request Body

Name
Type
Description

phone*

String

Phone number of the recipient

name

String

Name of recipient

execute_at

Epoch Timestamp in milliseconds

The time when you want to send the message.

media_url

URL

// Required - if the template is of type media

Public accessible media URL for Media Templates like an Image, Video, or Document.

IMAGE: Supported types: image/jpeg, image/png

VIDEO: Supported types: video/mp4, video/3gpp

DOCUMENT:

Supported types: Any valid MIME-type

MORE CUSTOM FIELDS

Key-Value Pairs

More data in the key-value format used in campaign params and button params

event_id

String (50 chars)

Event identifier that can be passed and accessed in the Playbooks (Custom Bots)

Bot Reference field: user.context.event_id

{
    "id": "<message_id>",
    "state": "SENT"
}
{
    "error": "Phone not found!"
}
{
    "error": "Campaign not found"
}

{
    "error": "Unauthorized"
}
{
    "id": "<message_id>",
    "state": "NOT_SENT",
    "reason": "<Error from WhatsApp>"
}
{
    "id": null,
    "state": "SCHEDULED",
    "scheduled_at": 1707379191 // Epoch time at which message will go.
}
{
    "error": "Campaign not active"
}

Sample CURL Request

curl --location --request POST 'https://app.quickreply.ai/api/campaign/XSSsd8AdrSMFfWrW_camp/event' \
--header 'client-id: Dpg3vnsdjfXwoSGNrT52G_c' \
--header 'secret-key: MDbkebDsldf9adsjbKJ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "phone": "+919634687270",
    "execute_at": "1707208191000",
    "name": "Utkarsh",
    "event_id": "XXXXXXXXXXXXXXXXXXXX",
    "var_1": "Blue Ribbon",
    "var_2": "4",
    "var_3":"₹4500",
    "media_url":"https:/some-public-domain/sample_image.jpeg"
}'
PreviousSend Template APINextExternal CRM Integration

Last updated 1 year ago

Was this helpful?

You can find client-id of your account in

You can find secret-key of your account in

Fields marked with are Required.

*️
Settings > Developers > API credentials
Settings > Developers > API credentials