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	You can find client-id of your account in Settings > Developers > API credentials
secret-key*	String	You can find secret-key of your account in Settings > Developers > API credentials
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

200: OK When message is successfully sent

{
    "id": "<message_id>",
    "state": "SENT"
}

400: Bad Request When recipient is missing

{
    "error": "Phone not found!"
}

400: Bad Request When campaign id is missing or is wrong

{
    "error": "Campaign not found"
}

Untitled

401: Unauthorized When client-id or secret-key is missing or wrong

{
    "error": "Unauthorized"
}

400: Bad Request When message fails at WhatsApp

{
    "id": "<message_id>",
    "state": "NOT_SENT",
    "reason": "<Error from WhatsApp>"
}

202: Accepted When message is scheduled successfully

{
    "id": null,
    "state": "SCHEDULED",
    "scheduled_at": 1707379191 // Epoch time at which message will go.
}

400: Bad Request When campaign is not set up properly

{
    "error": "Campaign not active"
}

Fields marked with *️ are Required.

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": "[phone]",
    "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"
}'