> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Gupshup

The Gupshup connector lets your AI agent act in each user's Gupshup account. Each user connects their own Gupshup API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 15 tools.

**Authentication:** API Key
**Categories:** Communication, Marketing
**Tools:** 15: 7 read, 8 write, 0 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=GUPSHUP)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Gupshup connection

   In **AgentKit > Connections**, create a Gupshup connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'gupshup'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Gupshup:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'gupshup_blocked_users_list',
     toolInput: { app_id: 'YOUR_APP_ID' },
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "gupshup"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Gupshup:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={"app_id":"YOUR_APP_ID"},
       tool_name="gupshup_blocked_users_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Gupshup credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'gupshup_blocked_users_list',
  toolInput: {
    app_id: '<app_id>',
  },
  connector: 'gupshup',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="gupshup_blocked_users_list",
    tool_input={
        "app_id": "<app_id>",
    },
    connection_name="gupshup",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `gupshup_blocked_users_list`

List Blocked Users · Read-only

List the WhatsApp users your Gupshup app's business number has blocked, one page at a time.
Returns blocked users with their wa_id and a paging cursor for the next page.
Use this to audit blocks. Use gupshup_users_unblock to unblock someone.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_id` (`string`, required): Gupshup app ID of the WhatsApp app, shown on the app's dashboard in the Gupshup console (Dashboard > WhatsApp > your app) and in the app settings. Example: cebxx8x1-xxf6-406c-901x-3f78xxxx5ea
- `after` (`string`, optional): Cursor for the next page, from the paging.cursors.after value of the previous response. Example: QVFIUmFfZA2ZAW
- `limit` (`integer`, optional): Users per page, up to 100. Defaults to 100. Example: 100

Example input: `{"app_id":"<app_id>"}`

### `gupshup_business_details_get`

Get Business Details · Read-only

Get the WhatsApp Business account details linked to a Gupshup app.
Returns business details such as the WABA ID, display name, phone number, verification and messaging limit information.
Use this for account-level details. Use gupshup_business_profile_get for the public profile fields customers see.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_id` (`string`, required): Gupshup app ID of the WhatsApp app, shown on the app's dashboard in the Gupshup console (Dashboard > WhatsApp > your app) and in the app settings. Example: cebxx8x1-xxf6-406c-901x-3f78xxxx5ea

Example input: `{"app_id":"<app_id>"}`

### `gupshup_business_profile_about_get`

Get Business Profile About · Read-only

Get the About text of a Gupshup app's WhatsApp business profile.
Returns the about message.
Use this for the short About line only. Use gupshup_business_profile_get for the rest of the profile.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_id` (`string`, required): Gupshup app ID of the WhatsApp app, shown on the app's dashboard in the Gupshup console (Dashboard > WhatsApp > your app) and in the app settings. Example: cebxx8x1-xxf6-406c-901x-3f78xxxx5ea

Example input: `{"app_id":"<app_id>"}`

### `gupshup_business_profile_get`

Get Business Profile · Read-only

Get the public WhatsApp business profile of a Gupshup app.
Returns the profile address, description, email, vertical and websites.
Use this to read the profile customers see. Use gupshup_business_profile_update to change it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_id` (`string`, required): Gupshup app ID of the WhatsApp app, shown on the app's dashboard in the Gupshup console (Dashboard > WhatsApp > your app) and in the app settings. Example: cebxx8x1-xxf6-406c-901x-3f78xxxx5ea

Example input: `{"app_id":"<app_id>"}`

### `gupshup_business_profile_photo_get`

Get Business Profile Photo · Read-only

Get the link to the profile photo of a Gupshup app's WhatsApp business profile.
Returns a URL for the current profile photo.
Use this to read the photo link. Changing the photo needs a file upload, which this connector does not support.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_id` (`string`, required): Gupshup app ID of the WhatsApp app, shown on the app's dashboard in the Gupshup console (Dashboard > WhatsApp > your app) and in the app settings. Example: cebxx8x1-xxf6-406c-901x-3f78xxxx5ea

Example input: `{"app_id":"<app_id>"}`

### `gupshup_template_get`

Get Template · Read-only

Get one WhatsApp message template of a Gupshup app by its Gupshup template ID.
Returns the template with its body, category, language, status, type, buttons and Meta externalId.
Use this to check one template's approval status or content. Use gupshup_templates_list to search all templates.
Needs template_id from gupshup_templates_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_id` (`string`, required): Gupshup app ID of the WhatsApp app, shown on the app's dashboard in the Gupshup console (Dashboard > WhatsApp > your app) and in the app settings. Example: cebxx8x1-xxf6-406c-901x-3f78xxxx5ea
- `template_id` (`string`, required): Gupshup template ID (the id field from the template list). Example: 312371e9-2771-463b-8cfd-cd8994b810cc

Example input: `{"app_id":"<app_id>","template_id":"<template_id>"}`

### `gupshup_templates_list`

List Templates · Read-only

List the WhatsApp message templates of a Gupshup app, optionally filtered by status, category, type, quality or language.
Returns templates with id, elementName, category, languageCode, status, templateType, data (body) and the Meta externalId.
Use this to find a template's id before sending. Use gupshup_template_get for one template you already have the ID of.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_id` (`string`, required): Gupshup app ID of the WhatsApp app, shown on the app's dashboard in the Gupshup console (Dashboard > WhatsApp > your app) and in the app settings. Example: cebxx8x1-xxf6-406c-901x-3f78xxxx5ea
- `language_code` (`string`, optional): Only return templates in this language code. Example: en
- `page_no` (`integer`, optional): Zero-based page number. Defaults to 0. Example: 0
- `page_size` (`integer`, optional): Templates per page. Defaults to 100. Example: 100
- `quality` (`string`, optional): Only return templates with this Meta quality rating, for example GREEN, YELLOW, RED or UNKNOWN. Example: GREEN
- `template_category` (`string`, optional): Only return templates in this category. Example: MARKETING. One of: `MARKETING`, `UTILITY`, `AUTHENTICATION`.
- `template_status` (`string`, optional): Only return templates with this approval status, for example APPROVED, PENDING or REJECTED. Example: APPROVED
- `template_type` (`string`, optional): Only return templates of this type, for example TEXT, IMAGE, VIDEO, DOCUMENT, LOCATION, CAROUSEL or PRODUCT. Example: TEXT

Example input: `{"app_id":"<app_id>"}`

### `gupshup_business_profile_about_update`

Update Business Profile About · Write

Set the About text of a Gupshup app's WhatsApp business profile.
Returns status success when the text is saved.
Use this for the About line only. Use gupshup_business_profile_update for address, description, email and websites.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `about` (`string`, required): New About text (up to 139 characters). Example: Shop the latest collections
- `app_id` (`string`, required): Gupshup app ID of the WhatsApp app, shown on the app's dashboard in the Gupshup console (Dashboard > WhatsApp > your app) and in the app settings. Example: cebxx8x1-xxf6-406c-901x-3f78xxxx5ea

Example input: `{"about":"<about>","app_id":"<app_id>"}`

### `gupshup_business_profile_update`

Update Business Profile · Write

Create or update the public WhatsApp business profile of a Gupshup app: address, description, email, vertical and websites.
Returns status success when the profile is saved.
Use this to change profile fields. Use gupshup_business_profile_about_update for the About text.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_id` (`string`, required): Gupshup app ID of the WhatsApp app, shown on the app's dashboard in the Gupshup console (Dashboard > WhatsApp > your app) and in the app settings. Example: cebxx8x1-xxf6-406c-901x-3f78xxxx5ea
- `address_line_1` (`string`, optional): First line of the business address. Example: 101, Silver Metropolis
- `address_line_2` (`string`, optional): Second line of the business address. Example: Goregaon East
- `city` (`string`, optional): City of the business address. Example: Mumbai
- `country` (`string`, optional): Country of the business address. Example: India
- `description` (`string`, optional): Business description shown on the profile. Example: Fashion and lifestyle store
- `pin_code` (`string`, optional): Postal code of the business address. Example: 400063
- `profile_email` (`string`, optional): Contact email shown on the profile. Example: support@example.com
- `state` (`string`, optional): State of the business address. Example: Maharashtra
- `vertical` (`string`, optional): Business category shown on the profile, for example Retail, Education, Professional Services or Other. Example: Retail
- `website_1` (`string`, optional): First website URL shown on the profile. Example: https://www.example.com
- `website_2` (`string`, optional): Second website URL shown on the profile. Example: https://shop.example.com

Example input: `{"app_id":"<app_id>"}`

### `gupshup_marketing_message_send`

Send Marketing Message (MM Lite) · Write

Send an approved marketing template through Meta's Marketing Messages Lite API via Gupshup, using the Cloud API template payload.
Returns the Cloud API response with the recipient's wa_id and the message id.
Use this only for MARKETING templates on apps onboarded to MM Lite. Use gupshup_template_message_send for utility and authentication templates.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_id` (`string`, required): Gupshup app ID of the WhatsApp app, shown on the app's dashboard in the Gupshup console (Dashboard > WhatsApp > your app) and in the app settings. Example: cebxx8x1-xxf6-406c-901x-3f78xxxx5ea
- `template` (`object`, required): Meta template payload: the template name, a language object with the code (and policy deterministic), and a components list with the body, header and button parameters. Example: {"name": "diwali_offer", "language": {"policy": "deterministic", "code": "en"}, "components": [{"type": "body", "parameters": [{"type": "text", "text": "John"}]}]}
- `to` (`string`, required): Recipient's WhatsApp number in international format with country code. Example: 919876543210

Example input: `{"app_id":"<app_id>","template":{},"to":"<to>"}`

### `gupshup_product_template_message_send`

Send Catalog Template Message · Write

Send an approved catalog or multi-product (MPM) WhatsApp template message from your Gupshup app.
Returns status submitted and the Gupshup messageId.
Use this only for catalog and multi-product templates, which Gupshup sends through its raw message endpoint. Use gupshup_template_message_send for every other template type.
Needs the template id from gupshup_templates_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_name` (`string`, required): Name of the Gupshup app that the source number belongs to, exactly as shown in the Gupshup console. Example: DemoApp
- `destination` (`string`, required): Recipient's WhatsApp number in international format with country code and no plus sign. Example: 919876543210
- `source` (`string`, required): Your business WhatsApp number that sends the message, registered to the app, in international format with country code and no plus sign. Example: 917834811114
- `template` (`string`, required): JSON-encoded template object with the Gupshup template id and its params. For multi-product templates the last param must be the retailer ID of the product used as the thumbnail. Example: {"id":"a1b2c3d4-0000-4000-8000-1234567890ab","params":["Diwali sale","SKU-1001"]}

Example input: `{"app_name":"<app_name>","destination":"<destination>","source":"<source>","template":"<template>"}`

### `gupshup_session_message_send`

Send Session Message · Write

Send a free-form WhatsApp session message (text, media, location, reaction, list, quick reply, product or CTA URL) from your Gupshup app.
Returns status submitted and the Gupshup messageId; delivery and read updates arrive on your app's callback URL.
Use this inside the 24-hour customer service window. Use gupshup_template_message_send to start a conversation with an approved template.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_name` (`string`, required): Name of the Gupshup app that the source number belongs to, exactly as shown in the Gupshup console. Example: DemoApp
- `destination` (`string`, required): Recipient's WhatsApp number in international format with country code and no plus sign. Example: 919876543210
- `message` (`string`, required): The WhatsApp message as a JSON-encoded string (Gupshup reads this form field as JSON). Set type to one of: text (text, optional previewUrl), image (originalUrl, previewUrl, optional caption), video, audio, file (url, filename), sticker (url), location (longitude, latitude, name, address), reaction (msgId of the message to react to, emoji), list or quick_reply (interactive menus with options), catalog, product, product_details or cta_url. Add a context object with msgId to reply to a specific message. Session messages only reach users who messaged you in the last 24 hours. Example: {"type":"text","text":"Hi John, your order has shipped.","previewUrl":false}
- `source` (`string`, required): Your business WhatsApp number that sends the message, registered to the app, in international format with country code and no plus sign. Example: 917834811114
- `disable_preview` (`boolean`, optional): Set true to stop WhatsApp from showing a link preview for a URL in a text message. Example: true

Example input: `{"app_name":"<app_name>","destination":"<destination>","message":"<message>","source":"<source>"}`

### `gupshup_template_message_send`

Send Template Message · Write

Send an approved WhatsApp template message (text, media header, location, coupon code, carousel, limited-time offer or authentication) from your Gupshup app.
Returns status submitted and the Gupshup messageId; delivery status arrives on your app's callback URL.
Use this to start or resume a conversation outside the 24-hour window. Use gupshup_session_message_send for free-form replies and gupshup_product_template_message_send for catalog and multi-product templates.
Needs the template id from gupshup_templates_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `destination` (`string`, required): Recipient's WhatsApp number in international format with country code and no plus sign. Example: 919876543210
- `source` (`string`, required): Your business WhatsApp number that sends the message, registered to the app, in international format with country code and no plus sign. Example: 917834811114
- `template` (`string`, required): JSON-encoded template object: id is the Gupshup template ID and params is the list of values for the template's {{1}}, {{2}}... placeholders in order (an empty list for templates without variables). Carousel and limited-time-offer templates add their card or expiry objects as shown in Gupshup's template message docs. Example: {"id":"312371e9-2771-463b-8cfd-cd8994b810cc","params":["John","ORD-1042"]}
- `app_name` (`string`, optional): Name of the Gupshup app that the source number belongs to, exactly as shown in the Gupshup console. Example: DemoApp
- `message` (`string`, optional): JSON-encoded media header for templates with an image, video, document or location header, for example an image object with a link or a media id. Leave empty for text-only templates. Example: {"type":"image","image":{"link":"https://example.com/banner.jpg"}}
- `postback_texts` (`string`, optional): JSON-encoded list of postback texts for the template's quick-reply buttons: each item gives the button index and the text Gupshup returns in the inbound event when the user taps it. Example: [{"index":0,"text":"confirm_order_1042"}]

Example input: `{"destination":"<destination>","source":"<source>","template":"<template>"}`

### `gupshup_users_block`

Block Users · Write

Block one or more WhatsApp users from messaging your Gupshup app's business number.
Returns the blocked users with their input number and wa_id, and any that failed.
Use this to stop abusive users. You can only block users who messaged you in the last 24 hours, up to 64,000 per WhatsApp Business Account. Use gupshup_users_unblock to undo.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_id` (`string`, required): Gupshup app ID of the WhatsApp app, shown on the app's dashboard in the Gupshup console (Dashboard > WhatsApp > your app) and in the app settings. Example: cebxx8x1-xxf6-406c-901x-3f78xxxx5ea
- `users` (`array`, required): Phone numbers of the users to block, in international format with country code. Example: ["919876543210"]

Example input: `{"app_id":"<app_id>","users":["919876543210"]}`

### `gupshup_users_unblock`

Unblock Users · Write

Unblock one or more WhatsApp users so they can message your Gupshup app's business number again.
Returns the unblocked users with their input number and wa_id.
Use this to reverse gupshup_users_block. Use gupshup_blocked_users_list to see who is blocked.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_id` (`string`, required): Gupshup app ID of the WhatsApp app, shown on the app's dashboard in the Gupshup console (Dashboard > WhatsApp > your app) and in the app settings. Example: cebxx8x1-xxf6-406c-901x-3f78xxxx5ea
- `users` (`array`, required): Phone numbers of the users to unblock, in international format with country code. Example: ["919876543210"]

Example input: `{"app_id":"<app_id>","users":["919876543210"]}`

## Related

Other Communication connectors ([all 132](/agentkit/connectors/?category=communication)):

- [Gmail](/agentkit/connectors/gmail/): Scalekit connector, OAuth, 48 tools
- [Slack](/agentkit/connectors/slack/): Scalekit connector, OAuth, 96 tools
- [Google Calendar](/agentkit/connectors/googlecalendar/): Scalekit connector, OAuth, 30 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
