Gupshup

Gupshup is a conversational messaging and CPaaS platform (headquartered in India) that lets businesses send and receive messages across WhatsApp, SMS, RCS, and other channels, plus build chatbots and conversational AI journeys. The developer platform exposes REST APIs on api.gupshup.io - most prominently the WhatsApp Business API (send session and template messages, opt-in management, templates, media, and inbound webhooks) - authenticated with an apikey header and scoped to a registered app. Separate SMS, RCS, and Partner API surfaces are also documented.

6 APIs 0 Features
MessagingWhatsAppConversational AICPaaSSMSRCSIndiaChatbotsBusiness MessagingCommunications

APIs

Gupshup WhatsApp Messaging API

Send session (user-initiated, 24-hour window) WhatsApp messages of many types - text, image, file, audio, video, sticker, location, contact, and interactive list / quick-reply -...

Gupshup WhatsApp Template Messaging API

Send pre-approved WhatsApp template (HSM) messages to opted-in users outside the 24-hour session window via POST /template/msg, and list an app's templates and their approval st...

Gupshup WhatsApp Opt-In Management API

Mark a user as opted-in or opted-out for an app and list the users who have interacted with your business number and their opt-in status. Required before template notifications ...

Gupshup SMS API

Broadcast SMS to a single number or many numbers programmatically via POST /msg on the /sm surface. Note - Gupshup has announced end-of-life for the /sm endpoints and recommends...

Gupshup RCS API

Send RCS (Rich Communication Services) business messages - rich cards, carousels, suggested replies, and media. RCS is onboarding-gated (username / password issued by Gupshup) a...

Gupshup Partner API

Token-authenticated Partner surface (partner.gupshup.io) for BSPs and resellers - manage apps, templates, subscriptions/callbacks, and send messages through Meta-format passthro...

Collections

Gupshup WhatsApp Business API

OPEN

Pricing Plans

Gupshup Plans Pricing

4 plans

PLANS

Rate Limits

Gupshup Rate Limits

4 limits

RATE LIMITS

FinOps

Gupshup Finops

FINOPS

Resources

🔗
AgenticAccess
AgenticAccess
🔑
Authentication
Authentication
🔗
DomainSecurity
DomainSecurity
🔗
LinkedIn
LinkedIn
🔗
Website
Website
🔗
Documentation
Documentation
🔗
Plans
Plans
🔗
RateLimits
RateLimits
🔗
FinOps
FinOps
📰
Blog
Blog

Sources

Raw ↑ 
opencollection: 1.0.0
info:
  name: Gupshup WhatsApp Business API
  version: '1.0'
request:
  auth:
    type: apikey
    apikey:
      key: apikey
      value: '{{apikey}}'
      in: header
items:
- info:
    name: Messaging
    type: folder
  items:
  - info:
      name: Send a WhatsApp session message.
      type: http
    http:
      method: POST
      url: https://api.gupshup.io/wa/api/v1/msg
      headers:
      - name: apikey
        value: '{{apikey}}'
      - name: Content-Type
        value: application/x-www-form-urlencoded
      body:
        type: urlencoded
        data: channel=whatsapp&source=919000000000&destination=919111111111&message=%7B%22type%22%3A%22text%22%2C%22text%22%3A%22Hello%20from%20Gupshup%22%7D&src.name={{appName}}
    docs: Sends a WhatsApp session message. Confirmed endpoint.
- info:
    name: Templates
    type: folder
  items:
  - info:
      name: Send a WhatsApp template message.
      type: http
    http:
      method: POST
      url: https://api.gupshup.io/wa/api/v1/template/msg
      headers:
      - name: apikey
        value: '{{apikey}}'
      - name: Content-Type
        value: application/x-www-form-urlencoded
      body:
        type: urlencoded
        data: channel=whatsapp&source=919000000000&destination=919111111111&template=%7B%22id%22%3A%22TEMPLATE_ID%22%2C%22params%22%3A%5B%22Kin%22%5D%7D&src.name={{appName}}
    docs: Sends a pre-approved template (HSM) message to an opted-in user. Confirmed endpoint.
  - info:
      name: List an app's templates.
      type: http
    http:
      method: GET
      url: https://api.gupshup.io/wa/api/v1/template/list/:appName
      headers:
      - name: apikey
        value: '{{apikey}}'
      params:
      - name: appName
        value: ''
        type: path
        description: Gupshup app name.
    docs: Lists templates registered for an app and their approval status. Modeled from documentation.
- info:
    name: Opt-In
    type: folder
  items:
  - info:
      name: Mark a user opt-in.
      type: http
    http:
      method: POST
      url: https://api.gupshup.io/wa/api/v1/app/opt/in/:appName
      headers:
      - name: apikey
        value: '{{apikey}}'
      - name: Content-Type
        value: application/x-www-form-urlencoded
      params:
      - name: appName
        value: ''
        type: path
        description: Gupshup app name.
      body:
        type: urlencoded
        data: user=919111111111
    docs: Records user consent to receive messages. Modeled from documentation.
  - info:
      name: Mark a user opt-out.
      type: http
    http:
      method: POST
      url: https://api.gupshup.io/wa/api/v1/app/opt/out/:appName
      headers:
      - name: apikey
        value: '{{apikey}}'
      - name: Content-Type
        value: application/x-www-form-urlencoded
      params:
      - name: appName
        value: ''
        type: path
        description: Gupshup app name.
      body:
        type: urlencoded
        data: user=919111111111
    docs: Records that a user opted out. Modeled from documentation.
  - info:
      name: List interacted users and opt-in status.
      type: http
    http:
      method: GET
      url: https://api.gupshup.io/wa/api/v1/users/:appName
      headers:
      - name: apikey
        value: '{{apikey}}'
      params:
      - name: appName
        value: ''
        type: path
        description: Gupshup app name.
    docs: Lists users who interacted with your business number and their opt-in status. Modeled from documentation.
bundled: true