Whautomate Help
Visit our websitePricingRequest DemoRoadmap
  • 👋Welcome to Whautomate
  • Overview
    • 💡What we do
    • ✨Our Features
  • Fundamentals
    • 🛠️Getting Started
      • Customer Service
      • Marketing
      • Sales
      • E-Commerce
      • Appointments
      • Classes & Subscriptions
    • 🎯Onboarding Checklist
      • Appointments
      • Classes
      • E-Commerce
      • Customer Service
  • Product Guides
    • Communication
      • Connect a Communication Channel
      • Omni Channel Team Inbox
      • Contacts
      • Segmentation & Broadcasts
      • Email/SMS Sender Configuration
      • Marketing opt-out Management
      • ⚡Canned Responses
      • ⭐CSAT Score
    • Automation
      • Triggers
        • Incoming WhatsApp Messages
        • Outgoing WhatsApp Messages
        • Appointment Updates
        • Happy Birthday Automation
        • Client Anniversary Automation
        • When a Client is created
        • When a Client is added to a Tag
        • When a Client is removed from a Tag
        • When a Contact is created
        • When a Contact is added to a Tag
        • When a Contact is removed from a Tag
        • When a Contact Status Changes
        • When a Client Completes a Form
        • When a Client is assigned a Form
        • When someone Completes an anonymous Form
        • Subscription Updates
        • Order Updates
        • Invoice Updates
        • Credits Usage Updates
        • Class Participant Updates
        • Incoming Messenger Messages
        • Outgoing Messenger Messages
        • Incoming Instagram Messages
        • Outgoing Instagram Messages
        • Incoming Telegram Messages
        • Outgoing Telegram Messages
        • Incoming Website Messages
        • Outgoing Website Messages
        • Shopify - Abandoned Cart
        • Shopify - Order Created
        • Shopify - Order Fulfilled
        • Shopify - Order Cancelled
        • WooCommerce - Abandoned Cart
        • WooCommerce - Order Status Changes
      • Setup WhatsApp Chatbot
      • WhatsApp AI Chatbot - Customer Service
      • Telegram AI Chatbot - Customer Service
      • Chatbot Demos
      • WhatsApp Drip Campaign
      • Birthday Wishes Campaign
      • Automate Reviews & Surveys
    • Invoice & Payment links
      • Setup Payment Gateway
      • Update Business Settings
      • Invoice & Payments
      • Invoice Statements
      • Send Invoice PDF - Personalize WhatsApp, Email and SMS template
      • Invoice Request Payment - Personalize WhatsApp, Email and SMS template
    • E-Commerce
      • Setup WhatsApp Catalog
        • Add Items - Manual
        • Add Items - Data Feed
        • Add Items - Connect Partner Platform
      • Manage Inventory & Link WhatsApp Catalog
      • WhatsApp E-Commerce Chatbot
      • Automate Order Updates
      • Automate Order Reviews & Surveys
    • Appointments
      • Setup Team Member Profile
      • Setup Services
      • Book Appointments - Admin
      • Setup Whatsapp Flow Appointment Chatbot
      • Setup Appointment Chatbot
      • Setup Appointment Notifications
      • Setup Appointment Notifications for Staffs
      • Setup Bulk Appointment Notifications
      • Setup Booking Portal
      • Sync Appointments with External Calendars
      • Bulk Import Services
      • Setup Virtual/Online Session Services
      • Setup Virtual/Online Session Notifications
    • Plans & Subscriptions
      • Setup Plans
      • Setup Subscriptions
    • Class Bookings
      • Bulk Import Classes
      • Setup Classes
      • Setup Class Batches
      • Setup Class Notifications
      • Setup Bulk Class Notifications for Participants
      • Setup Class Booking Chatbot
      • Setup Whatsapp Flow Class Booking Chatbot
      • Setup Class Booking Portal
    • Forms
      • Request Form - Personalize WhatsApp, Email and SMS template
      • Personalize Your Form Response PDFs: Template Editor
      • Form Automations
      • Payment Forms
    • Coupons
    • Loyalty Program
      • Automate Loyalty Program Notifications via WhatsApp
    • Integrations
      • WhatsApp Cloud API
        • WhatsApp Payment Method
        • Meta Business Verification
        • WhatsApp Profile
        • WhatsApp Compliance Info
        • WhatsApp Commerce Settings
        • WhatsApp Message Templates
        • Linking WhatsApp Number (WABA) to Your Facebook Page
        • How to Add WhatsApp Button to Your Instagram Account
        • Setup Click-to-WhatsApp Ads (CTWA)
      • Instagram
      • Facebook Messenger
      • Telegram
      • Livechat
      • OpenAI
      • Stripe
      • Razorpay
      • Shopify
        • Shopify Automations
      • WooCommerce
        • Woocommerce Automations
      • Rest API
      • MyFatoorah
      • Zoom
      • Webhooks
        • Clients
        • Contacts
        • Messages
        • Appointments
        • Classes
        • Invoice Updates
      • Zapier
    • Client CRM
      • Bulk Import Clients
      • Client Details
      • Client Notes
      • Client Documents
      • Client Letters
      • Client Forms
    • WhatsApp Chat Widget
    • Whautomate Rest API
      • Client Tags
      • Clients
      • Contact Tags
      • Contacts
      • Locations
      • Staffs
      • Segments
      • Broadcasts
      • Messages
      • Service Categories
      • Services
      • Appointments
      • Classes
      • Webhooks
      • Whautomate REST API Error Messages
    • Whautomate FAQs
      • My WhatsApp Template Message Failing to Send to Some Users?
      • How to Check My WhatsApp Quality Rating and Messaging Limits?
      • How to Install the Whautomate Progressive Web Application?
      • Why Does My Whautomate Account Frequently Log Out?
      • How to Get the WhatsApp Green Tick in 3 Easy Steps
      • Essential Tips to Avoid WhatsApp Business Account/API Restrictions & Bans
      • How to Check Undeliverable or Failed WhatsApp Contacts in Whautomate
      • How to Delete Your WhatsApp Business API Number?
  • Account Management
    • Manage Subscription
      • Choose Your Plan
      • Upgrade Subscription
      • Whautomate Add-ons
      • Update Payment Method
      • Subscription Cancelations
    • Account Settings
    • Team Members Management
      • Invite, Activate or De-activate Members
      • Roles and Permissions
    • Forgot Password
    • Reset Password
    • Two Factor Authentication
  • WhatsApp Pricing
    • WhatsApp pricing Calculator - USD
    • WhatsApp pricing Calculator - INR
    • WhatsApp Pricing Calculator - EUR
Powered by GitBook
On this page
  1. Product Guides
  2. Whautomate Rest API

Messages

Use our omnichannel API to send messages across multiple channels using our API.

PreviousBroadcastsNextService Categories

Last updated 7 months ago

Effective and efficient communication remains pivotal for businesses seeking to engage with their customers in the ever-evolving digital landscape. Recognising this need, Whautomate's Messages Endpoint emerges as a versatile and powerful tool, designed to streamline and enhance your messaging capabilities across multiple popular platforms, including Telegram, Instagram, WhatsApp, and Messenger.

Get Messages of Contact

WhatsApp

Please note you can only send Media and Text Messages when there is an active session (24 hr period). You can send template messages to a contact any time even if there is no active session. You can send WhatsApp messages to

  • Contact

  • Client

  • Recepient

Simply send the message to a recepient with phoneNumber and name, the platform will create or use the existing contact in your account. If you already have a contact or Client created in Whautomate and you have those identifiers, use those identifiers to send the message to them. If not use recepient instead.

POST /users

<Description of the endpoint>

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Body

Name
Type
Description

name

string

Name of the user

age

number

Age of the user

Response

{
  "id": 1,
  "name": "John",
  "age": 30
}
{
  "error": "Invalid request"
}

Telegram

Instagram

Messenger

post
Authorizations
Header parameters
x-api-keystringRequired
Body
scheduleDateTimestringOptional
headerMediaUrlstringOptional
headerTextParametersstring[]Optional
bodyTextParametersstring[]Optional
buttonUrlParametersstring[]Optional
Responses
200
200 response
application/json
post
POST /v1/messages/whatsapp/sendtemplate HTTP/1.1
Host: Your Host
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 447

{
  "client": {
    "id": "text"
  },
  "contact": {
    "id": "text"
  },
  "recepient": {
    "phoneNumber": "text",
    "name": "text"
  },
  "scheduleDateTime": "text",
  "template": {
    "name": "text",
    "language": "text"
  },
  "headerMediaUrl": "text",
  "headerTextParameters": [
    "text"
  ],
  "bodyTextParameters": [
    "text"
  ],
  "buttonUrlParameters": [
    "text"
  ],
  "locationParameters": {
    "latitude": 1,
    "longitude": 1,
    "address": "text",
    "name": "text"
  },
  "flowParameters": {
    "flowToken": "text",
    "flowData": "text"
  },
  "location": {
    "id": "text"
  }
}
200

200 response

{
  "client": {
    "id": "text"
  },
  "contact": {
    "id": "text"
  },
  "recepient": {
    "phoneNumber": "text",
    "name": "text"
  },
  "scheduleDateTime": "text",
  "template": {
    "name": "text",
    "language": "text"
  },
  "headerMediaUrl": "text",
  "headerTextParameters": [
    "text"
  ],
  "bodyTextParameters": [
    "text"
  ],
  "buttonUrlParameters": [
    "text"
  ],
  "locationParameters": {
    "latitude": 1,
    "longitude": 1,
    "address": "text",
    "name": "text"
  },
  "flowParameters": {
    "flowToken": "text",
    "flowData": "text"
  },
  "location": {
    "id": "text"
  }
}
get
Path parameters
contactIdstringRequired
Query parameters
limitstringOptional
pagestringOptional
searchTextstringOptional
Header parameters
x-api-keystringRequired
Responses
200
200 response
application/json
get
GET /v1/messages/{contactId} HTTP/1.1
Host: Your Host
x-api-key: text
Accept: */*
200

200 response

[
  {
    "id": "text",
    "contact": {
      "id": "text",
      "channel": "text",
      "phoneNumber": "text"
    },
    "channel": "text",
    "isIncoming": true,
    "type": "text",
    "sentBy": "text",
    "status": "text",
    "errorMessage": "text",
    "mediaUrl": "text",
    "text": "text",
    "footerText": "text",
    "options": {
      "type": "text",
      "buttons": [
        {
          "type": "text",
          "text": "text",
          "url": "text"
        }
      ]
    }
  }
]
  • Get Messages of Contact
  • GET/v1/messages/{contactId}
  • WhatsApp
  • POST/v1/messages/whatsapp/sendtemplate
  • POST/v1/messages/whatsapp/sendmedia
  • POST/v1/messages/whatsapp/sendtext
  • Telegram
  • POST/v1/messages/telegram/sendmedia
  • POST/v1/messages/telegram/sendtext
  • POST/v1/messages/telegram/sendtemplate
  • Instagram
  • POST/v1/messages/instagram/sendmedia
  • POST/v1/messages/instagram/sendtemplate
  • POST/v1/messages/instagram/sendtext
  • Messenger
  • POST/v1/messages/messenger/sendmedia
  • POST/v1/messages/messenger/sendtemplate
  • POST/v1/messages/messenger/sendtext
post
Header parameters
x-api-keystringRequired
Body
scheduleDateTimestringOptional
mimeTypestringRequired
mediaUrlstringRequired
Responses
200
200 response
application/json
post
POST /v1/messages/whatsapp/sendmedia HTTP/1.1
Host: Your Host
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 170

{
  "client": {
    "id": "text"
  },
  "contact": {
    "id": "text"
  },
  "recepient": {
    "phoneNumber": "text"
  },
  "scheduleDateTime": "text",
  "mimeType": "text",
  "mediaUrl": "text",
  "location": {
    "id": "text"
  }
}
200

200 response

{
  "success": true
}
post
Header parameters
x-api-keystringRequired
Body
scheduleDateTimestringOptional
textMessagestringRequired
Responses
200
200 response
application/json
post
POST /v1/messages/whatsapp/sendtext HTTP/1.1
Host: Your Host
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 155

{
  "client": {
    "id": "text"
  },
  "contact": {
    "id": "text"
  },
  "recepient": {
    "phoneNumber": "text"
  },
  "scheduleDateTime": "text",
  "textMessage": "text",
  "location": {
    "id": "text"
  }
}
200

200 response

{
  "success": true
}
post
Header parameters
x-api-keystringRequired
Body
scheduleDateTimestringOptional
mimeTypestringRequired
mediaUrlstringRequired
Responses
200
200 response
application/json
post
POST /v1/messages/telegram/sendmedia HTTP/1.1
Host: Your Host
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "contact": {
    "id": "text"
  },
  "scheduleDateTime": "text",
  "mimeType": "text",
  "mediaUrl": "text",
  "location": {
    "id": "text"
  }
}
200

200 response

{
  "success": true
}
post
Header parameters
x-api-keystringRequired
Body
scheduleDateTimestringOptional
textMessagestringRequired
Responses
200
200 response
application/json
post
POST /v1/messages/telegram/sendtext HTTP/1.1
Host: Your Host
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "contact": {
    "id": "text"
  },
  "scheduleDateTime": "text",
  "textMessage": "text",
  "location": {
    "id": "text"
  }
}
200

200 response

{
  "success": true
}
post
Header parameters
x-api-keystringRequired
Body
headerTypestring · enumOptionalPossible values:
mimeTypestringOptional
mediaUrlstringOptional
textMessagestringRequired
Responses
200
200 response
application/json
post
POST /v1/messages/telegram/sendtemplate HTTP/1.1
Host: Your Host
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 204

{
  "contact": {
    "id": "text"
  },
  "location": {
    "id": "text"
  },
  "headerType": "IMAGE",
  "mimeType": "text",
  "mediaUrl": "text",
  "textMessage": "text",
  "buttons": [
    {
      "type": "web_url",
      "title": "text",
      "payload": "text",
      "url": "text"
    }
  ]
}
200

200 response

{
  "success": true
}
post
Header parameters
x-api-keystringRequired
Body
scheduleDateTimestringOptional
mimeTypestringRequired
mediaUrlstringRequired
Responses
200
200 response
application/json
post
POST /v1/messages/instagram/sendmedia HTTP/1.1
Host: Your Host
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "contact": {
    "id": "text"
  },
  "scheduleDateTime": "text",
  "mimeType": "text",
  "mediaUrl": "text",
  "location": {
    "id": "text"
  }
}
200

200 response

{
  "success": true
}
post
Header parameters
x-api-keystringRequired
Body
Responses
200
200 response
application/json
post
POST /v1/messages/instagram/sendtemplate HTTP/1.1
Host: Your Host
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 239

{
  "contact": {
    "id": "text"
  },
  "location": {
    "id": "text"
  },
  "elements": [
    {
      "title": "text",
      "subtitle": "text",
      "image_url": "text",
      "default_action": {
        "type": "text",
        "url": "text"
      },
      "buttons": [
        {
          "type": "web_url",
          "title": "text",
          "payload": "text",
          "url": "text"
        }
      ]
    }
  ]
}
200

200 response

{
  "success": true
}
post
Header parameters
x-api-keystringRequired
Body
scheduleDateTimestringOptional
textMessagestringRequired
Responses
200
200 response
application/json
post
POST /v1/messages/instagram/sendtext HTTP/1.1
Host: Your Host
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "contact": {
    "id": "text"
  },
  "scheduleDateTime": "text",
  "textMessage": "text",
  "location": {
    "id": "text"
  }
}
200

200 response

{
  "success": true
}
post
Header parameters
x-api-keystringRequired
Body
scheduleDateTimestringOptional
mimeTypestringRequired
mediaUrlstringRequired
Responses
200
200 response
application/json
post
POST /v1/messages/messenger/sendmedia HTTP/1.1
Host: Your Host
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "contact": {
    "id": "text"
  },
  "scheduleDateTime": "text",
  "mimeType": "text",
  "mediaUrl": "text",
  "location": {
    "id": "text"
  }
}
200

200 response

{
  "success": true
}
post
Header parameters
x-api-keystringRequired
Body
Responses
200
200 response
application/json
post
POST /v1/messages/messenger/sendtemplate HTTP/1.1
Host: Your Host
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 239

{
  "contact": {
    "id": "text"
  },
  "location": {
    "id": "text"
  },
  "elements": [
    {
      "title": "text",
      "subtitle": "text",
      "image_url": "text",
      "default_action": {
        "type": "text",
        "url": "text"
      },
      "buttons": [
        {
          "type": "web_url",
          "title": "text",
          "payload": "text",
          "url": "text"
        }
      ]
    }
  ]
}
200

200 response

{
  "success": true
}
post
Header parameters
x-api-keystringRequired
Body
scheduleDateTimestringOptional
textMessagestringRequired
Responses
200
200 response
application/json
post
POST /v1/messages/messenger/sendtext HTTP/1.1
Host: Your Host
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "contact": {
    "id": "text"
  },
  "scheduleDateTime": "text",
  "textMessage": "text",
  "location": {
    "id": "text"
  }
}
200

200 response

{
  "success": true
}