{"info":{"_postman_id":"d2aa82ea-cbe0-4732-8ead-b94b888894e6","name":"Blueticks API","description":"

Send messages using your personal WhatsApp account

Download the extension:
https://blueticks.co/

endpoint = 'https://api.blueticks.co'

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"800229","collectionId":"d2aa82ea-cbe0-4732-8ead-b94b888894e6","publishedId":"TVsrG9VS","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"546FFF"},"publishDate":"2021-01-30T14:33:56.000Z"},"item":[{"name":"Send / Schedule a Message","id":"d90d5705-0716-40a4-83ad-bf66c42fdb49","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"to\": \"+1800555555\",\n \"message\": \"This is a scheduled test message\",\n \"apiKey\": \"yYBiIMwqvUWBWWzxEyvPzIuIGrGcHgJG\",\n \"dueDate\": \"2024-01-01T00:00:00.000Z\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.blueticks.co/messages","description":"

WhatsApp Messaging API Documentation

Overview

This API enables users to send messages through WhatsApp from their personal account. With features like message scheduling and attachment support, it provides flexibility for automated messaging campaigns. The Campaigner package offers enhanced capabilities, including sending messages without the need to keep WhatsApp Web open.

Features

Direct Messaging: Send messages using your personal WhatsApp account. WhatsApp Web must be actively open.
Campaigner Package: Subscribers can send messages without keeping WhatsApp Web open.
Message Scheduling: Schedule messages to be sent at a later time by specifying a dueDate in UTC.
Attachments: Add an attachment to your message by including an asset object with a public URL and MIME type.
Asynchronous Requests: Message requests are processed asynchronously.
Delivery Notifications: Receive a notification on the specified callbackUrl regarding the success or failure of the message delivery.

WhatsApp Messaging API Documentation

Overview

Features

Direct Messaging: Send messages using your personal WhatsApp account. WhatsApp Web must be actively open.
Campaigner Package: Subscribers can send messages without keeping WhatsApp Web open.
Message Scheduling: Schedule messages to be sent at a later time by specifying a dueDate in UTC.
Attachments: Add an attachment to your message by including an asset object with a public URL and MIME type.
Asynchronous Requests: Message requests are processed asynchronously.
Delivery Notifications: Receive a notification on the specified callbackUrl regarding the success or failure of the message delivery.

Usage

Sending a Message

Standard Message: Ensure WhatsApp Web is open. Format your request with the recipient's details and your message content.
With Campaigner Package: If you've purchased the Campaigner package, you can send messages without keeping WhatsApp Web open.

Scheduling a Message

Specify the dueDate in your request in UTC format to schedule your message.

Adding an Attachment

Include an asset object in your request with the following fields:

url: The public URL of the asset.
type: The MIME type of the asset. Refer to List of MIME Types for valid values.

Callback Notification

To receive notifications about the message delivery status, provide a callbackUrl in your request.

\n","urlObject":{"path":["messages"],"host":["https://api.blueticks.co"],"query":[],"variable":[]}},"response":[{"id":"8e8fc46a-94dd-4e01-b3ab-f366ed84b20a","name":"Send a simple text message","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"+1800555555\",\n \"message\": \"This is a test message\",\n \"apiKey\": \"yYBiIMwqvUWBWWzxEyvPzIuIGrGcHgJG\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.blueticks.co/messages"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": \"Message queued successfuly\",\n \"callbackUrl\": \"Not supplied\"\n}"},{"id":"ec9216b4-328d-4abe-a983-3ea69bd6a9ec","name":"Send message with an attachment","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"+1800555555\",\n \"message\": \"This is a test message with an image\",\n \"apiKey\": \"yYBiIMwqvUWBWWzxEyvPzIuIGrGcHgJG\",\n \"asset\": {\n \"url\": \"https://picsum.photos/200/300\",\n \"type\": \"image/jpeg\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.blueticks.co/messages"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": \"Message queued successfuly\",\n \"callbackUrl\": \"Not supplied\"\n}"},{"id":"afb52467-c706-4494-88bb-c744b03c8d56","name":"Schedule a message","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"+1800555555\",\n \"message\": \"This is a scheduled test message\",\n \"apiKey\": \"yYBiIMwqvUWBWWzxEyvPzIuIGrGcHgJG\",\n \"dueDate\": \"2024-01-01T00:00:00.000Z\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.blueticks.co/messages"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": true,\r\n \"message\": \"Message queued successfuly\",\r\n \"callbackUrl\": \"Not supplied\"\r\n}"},{"id":"e7d48e0b-0b39-497e-861e-81ae3fc0ac21","name":"Async response via callback","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"+1800555555\",\n \"message\": \"This is a test message with an image and callbackUrl\",\n \"apiKey\": \"yYBiIMwqvUWBWWzxEyvPzIuIGrGcHgJG\",\n \"asset\": {\n \"url\": \"https://picsum.photos/200/300\",\n \"type\": \"image/jpeg\"\n },\n \"callbackUrl\": \"https://webhook.site/d5b4e099-4b18-44fc-9e3e-9f0e40feb8f7\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.blueticks.co/messages"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": true,\r\n \"message\": \"Message queued successfuly\",\r\n \"callbackUrl\": \"https://webhook.site/d5b4e099-4b18-44fc-9e3e-9f0e40feb8f7\"\r\n}"}],"_postman_id":"d90d5705-0716-40a4-83ad-bf66c42fdb49"}],"event":[{"listen":"prerequest","script":{"id":"78b14532-7be5-4f38-8980-87f17cab0294","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cabba6f8-3af8-4e6f-ac9d-63ac5bcb47c1","type":"text/javascript","exec":[""]}}],"variable":[{"key":"endpoint","value":"https://api.blueticks.co"}]}