Gupshup API Documentation

This is the complete API documentation for connecting to the Gupshup API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Gupshup: Gupshup WhatsApp messaging, template, business profile, subscription, and user-management APIs for building and operating WhatsApp Business conversations. Keep reading to get started.

Quickstart

Before you run your first Gupshup request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one Gupshup connection — create or choose one in Connections. Note its connectionId.

Every Gupshup action uses the same URL pattern:

POST https://connect.mindcloud.co/v2/universal/apps/gupshup/actions/{actionSlug}/run

You need a MindCloud API Key and a Gupshup connection. Then call an action such as Get All Templates For App:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/gupshup/actions/get-all-templates-for-app/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authenticate with a MindCloud API Key plus a connectionId for your Gupshup account. See Gupshup API Authentication for the full flow and how to get your connection credentials.

Gupshup actions

All 40 published actions for this Gupshup version. Each page documents the endpoint, arguments, and response controls.

• POSTCreate Template
• POSTCreate Template With Buttons
• DELETEDelete Business Profile Photo
• GETGet All Templates For App
• GETGet Business Profile About
• GETGet Business Profile Details
• GETGet Business Profile Photo
• GETGet Template By Template ID
• PUTMark Message As Read
• POSTSend Authentication Template Message
• POSTSend Carousel Template Message
• POSTSend Catalog Message
• POSTSend Catalog Template Message
• POSTSend Contact Message
• POSTSend Copy Coupon Code Template Message
• POSTSend CTA Template Message
• POSTSend CTA URL Message
• POSTSend Document Template Message
• POSTSend File Message
• POSTSend Image Message
• POSTSend Image Template Message
• POSTSend List Message
• POSTSend Location Message
• POSTSend Location Template Message
• POSTSend Message
• POSTSend Multi Product Message
• POSTSend Quick Reply File Message
• POSTSend Quick Reply Media Message
• POSTSend Quick Reply Message
• POSTSend Quick Reply Template Message
• POSTSend Single Product Message
• POSTSend Sticker Message
• POSTSend Template Message
• POSTSend Text Message
• POSTSend Text Template Message
• POSTSend Video Message
• POSTSend Video Template Message
• PUTUpdate Business Profile About
• PUTUpdate Business Profile Details
• PUTUpdate Business Profile Photo

Related apps

More Communication apps on the Universal API, behind the same REST shape. Or browse all apps.

GmailSlackDiscordTwilioMicrosoft TeamsCircletl;dvClickSend SMS