# Gupshup Partner Documentation Documentation > Documentation for Gupshup Partner Documentation ## Guides - [Gupshup Partner Eco-System](https://partner-docs.gupshup.io/docs/gupshup-partner-eco-system.md) - [Solution Partners & Tech Providers](https://partner-docs.gupshup.io/docs/what-is-sp-tp.md) - [Get Solution ID from Meta](https://partner-docs.gupshup.io/docs/get-solution-id-from-meta.md) - [Pricing](https://partner-docs.gupshup.io/docs/pricing.md) - [Introduction](https://partner-docs.gupshup.io/docs/introduction.md) - [Wallet Overview](https://partner-docs.gupshup.io/docs/commissions.md) - [Create your first App](https://partner-docs.gupshup.io/docs/create-your-first-app.md) - [Generate Secret and Token](https://partner-docs.gupshup.io/docs/generate-secret-and-token.md) - [Partner Rate Limits](https://partner-docs.gupshup.io/docs/partner-rate-limits.md) - [Webhook Key Points](https://partner-docs.gupshup.io/docs/webhook-key-points.md) - [Subscription Management](https://partner-docs.gupshup.io/docs/set-callback-url-1.md) - [Inbound events](https://partner-docs.gupshup.io/docs/inbound-events.md) - [WhatsApp Messages](https://partner-docs.gupshup.io/docs/whatsapp-messages.md) - [Whatsapp Passthrough APIs for Partners](https://partner-docs.gupshup.io/docs/whatsapp-passthrough-apis-for-partners.md) - [User events](https://partner-docs.gupshup.io/docs/user-events.md) - [Message events](https://partner-docs.gupshup.io/docs/message-events.md) - [Billing events](https://partner-docs.gupshup.io/docs/billing-events.md) - [System events](https://partner-docs.gupshup.io/docs/system-events.md) - [PMP Events](https://partner-docs.gupshup.io/docs/pmp-events-1.md): Inbound v2 events post the per message based pricing roll out on 1st July 2025 - [Tier Based Pricing](https://partner-docs.gupshup.io/docs/tier-based-pricing.md): Tier Update Webhook (VOLUME_BASED_PRICING_TIER_UPDATE) - [Get Started Guide with Gupshup Flow Management APIs](https://partner-docs.gupshup.io/docs/get-started-guide-with-gupshup-flow-management-apis.md): This guide will tell you how to use Gupshup Flow management APIs - Partner APIs. - [Onboarding APIs](https://partner-docs.gupshup.io/docs/onboarding-apis.md) - [Events](https://partner-docs.gupshup.io/docs/events.md) - [PMP Events](https://partner-docs.gupshup.io/docs/pmp-events.md): Inbound v3 events post the per message based pricing roll out on 1st July 2025 - [Tier Based Pricing](https://partner-docs.gupshup.io/docs/tier-based-pricing-1.md): Tier Update Webhook (VOLUME_BASED_PRICING_TIER_UPDATE) - [Passthrough APIs-Flow Management](https://partner-docs.gupshup.io/docs/passthrough_apis_flow_management.md) - [WhatsApp Dynamic Flows](https://partner-docs.gupshup.io/docs/whatsapp-dynamic-flows.md): This guide helps you to create a WhatsApp Dynamic Flow - [Passthrough (V3) Incoming events](https://partner-docs.gupshup.io/docs/passthrough-v3-incoming-events.md): Event payloads for passthrough APIs. - [Unused Commission Policy](https://partner-docs.gupshup.io/docs/unused-commission-policy.md) - [Media Management](https://partner-docs.gupshup.io/docs/media-management.md) - [Marketing Messages Lite (MM Lite) API](https://partner-docs.gupshup.io/docs/marketing-messages-lite-mm-lite-api.md) - [Support](https://partner-docs.gupshup.io/docs/support.md) - [WhatsApp Brazil Payments](https://partner-docs.gupshup.io/docs/whatsapp-brazil-payments.md) - [Mark message as Read/Typing indicator](https://partner-docs.gupshup.io/docs/mark-message-as-readtyping-indicator.md): Typing indicators enhance the messaging experience by signaling to the WhatsApp user that a response is being prepared. This feature builds user trust and improves perceived responsiveness . - [Guide to WhatsApp Voice (Inbound) & SIP Integration via Gupshup](https://partner-docs.gupshup.io/docs/copy-of-guide-to-whatsapp-voice-inbound-sip-integration-via-gupshup.md): ## Introduction - [Guide to Voice Outbound (Business-initiated Calls) & SIP Integration via Gupshup](https://partner-docs.gupshup.io/docs/guide-to-voice-outbound-business-initiated-calls-sip-integration-via-gupshup.md) - [Obtain User Call Permissions](https://partner-docs.gupshup.io/docs/obtain-user-call-permissions.md) - [Permanent Call Permissions for WhatsApp Voice](https://partner-docs.gupshup.io/docs/permanent-call-permissions-for-whatsapp-voice.md) - [BSUID](https://partner-docs.gupshup.io/docs/bsuid.md): A BSUID is a unique user identifier that can be used to message a WhatsApp user when you don’t know their phone number. BSUID will be assigned to the userid parameter and appear in following messages webhooks - [Coexistence](https://partner-docs.gupshup.io/docs/co-existence-closed-beta-phase.md): Co-existence allows you to connect your existing WhatsApp Business App number to Gupshup. - [Enablement API - Coexistence ](https://partner-docs.gupshup.io/docs/copy-of-co-existence-closed-beta-phase.md): Co-existence allows you to connect your existing WhatsApp Business App number to Gupshup. - [Coexistence Events](https://partner-docs.gupshup.io/docs/coexistence-events.md) - [API to enable BSUID flag for an app](https://partner-docs.gupshup.io/docs/api-to-enable-bsuid-flag-for-an-app.md): This document describes the Partner Portal API that updates Business Scoped User ID (BSUID) flags on a WhatsApp app’s configuration on v2 or/and v3 subscriptions. You can enable eithter 1 or both subscriptions thorugh this API. - [Gupshup IP Allowlisting](https://partner-docs.gupshup.io/docs/gupshup-ip-allowlisting.md): To ensure a secure and reliable webhook experience, please whitelist the following Gupshup IP addresses in your system. This will allow seamless communication and prevent any disruptions in webhook delivery. - [Partner Authentication Guide: Universal Tokens (UT) and Universal App Tokens (UAT) Overview](https://partner-docs.gupshup.io/docs/partner-authentication-guide-universal-tokens-ut-overview.md) ## API Reference - [Get Partner Apps](https://partner-docs.gupshup.io/reference/get_partner-account-api-partnerapps.md): Retrieves the list of partner applications linked to the authenticated partner's account, including health status from DockerDetails and capping information from CappingDetails - [Link App with Partner](https://partner-docs.gupshup.io/reference/post_partner-account-api-applink.md): This API endpoint lets authenticated partners link a Gupshup application to their account using an API key and app name. - [Delete Sandbox App](https://partner-docs.gupshup.io/reference/deleteappsandbox.md): Use this API to delete Sandbox app. - [Register phone for an app](https://partner-docs.gupshup.io/reference/registerphoneapp.md) - [Deregister phone for an app](https://partner-docs.gupshup.io/reference/deregisterphoneapp.md): This API endpoint lets partners deregister their Phone Number (PN) from WhatsApp Business. It removes the phone number registration from WhatsApp services, disabling WhatsApp Business messaging for that number in the partner application. - [Get Partner Token](https://partner-docs.gupshup.io/reference/post_partner-account-login.md): This API endpoint enables partners to authenticate and login to the Partner Portal system. It supports API-based login (with JWT tokens). The endpoint validates credentials, generates authentication tokens, and returns comprehensive partner information including permissions, billing details, and feature flags. - [Get Access Token for an App](https://partner-docs.gupshup.io/reference/get_partner-app-appid-token.md): This API endpoint enables partners to generate or retrieve an access token for their partner application. The token is used for authenticating API calls to WhatsApp Business API and other Gupshup services. The endpoint follows an idempotent pattern - if a token already exists for the partner-app combination, it returns the existing token; otherwise, it generates a new one. - [Get All Subscriptions](https://partner-docs.gupshup.io/reference/get_partner-app-appid-subscription.md): This API endpoint retrieves all the current webhook subscription configuration for a partner application. It returns details about the subscribed event types, webhook URL, subscription status, and metadata. This is useful for verifying webhook configurations, auditing subscription settings, and troubleshooting event delivery issues. - [Get Specific App Subscription](https://partner-docs.gupshup.io/reference/get_partner-app-appid-subscription-subscriptionid.md): This API endpoint retrieves detailed information about a specific webhook subscription by its unique subscription ID. Unlike the general subscription endpoint, this provides granular access to individual subscription configurations with enhanced response fields including human-readable event modes array, latency bucket information, and complete subscription metadata. - [Set subscription for an app](https://partner-docs.gupshup.io/reference/setsubscription-api-v3.md): This API endpoint enables partners to subscribe to WhatsApp events (webhooks) for their partner application. When subscribed, WhatsApp will send real-time event notifications to the specified webhook URL for various event types like incoming messages, message status updates, user interactions, and more. This is essential for building interactive WhatsApp Business applications. - [Update App Subscription](https://partner-docs.gupshup.io/reference/put_partner-app-appid-subscription-subscriptionid.md): This API endpoint enables partners to update configuration of a specific webhook subscription by its unique subscription ID. This allows for granular modifications to individual subscriptions without affecting other webhooks or recreating the subscription. Common use cases include updating webhook URLs, changing event modes, modifying metadata, or toggling subscription status. - [Delete specific subscription of an app](https://partner-docs.gupshup.io/reference/delete_partner-app-appid-subscription-subscriptionid.md): This API endpoint enables partners to delete a specific webhook subscription by its unique subscription ID. Unlike the general delete subscription endpoint that removes all subscriptions for an app, this endpoint provides granular control to remove individual subscriptions when multiple webhook configurations exist. This is particularly useful for managing multi-environment setups, removing deprecated webhooks, or cleaning up test subscriptions. - [Delete all subscriptions for an app](https://partner-docs.gupshup.io/reference/delete_partner-app-appid-subscription.md): This API endpoint removes all webhook subscriptions for a partner application. This is a bulk operation that deletes every configured webhook at once. Use this with extreme caution as it's irreversible and will immediately stop all event deliveries to all webhooks. For removing individual subscriptions, use the delete specific subscription endpoint instead. - [Block Users](https://partner-docs.gupshup.io/reference/post_partner-app-appid-user-block.md): This API endpoint allows you to block one or more WhatsApp users from sending messages to your WhatsApp Business application. Blocked users will not be able to send messages, and your app will not receive any incoming messages from them. This is useful for preventing spam, harassment, or unwanted communication. Use the unblock endpoint to restore messaging for previously blocked users. - [Get Blocked Users list](https://partner-docs.gupshup.io/reference/get_partner-app-appid-user-blocklist.md): This API endpoint retrieves a paginated list of users who have been blocked from sending messages to your WhatsApp Business application. The endpoint supports cursor-based pagination for efficiently handling large lists of blocked users. This is useful for auditing blocked users, managing user access, and troubleshooting message delivery issues. - [Unblock Users](https://partner-docs.gupshup.io/reference/post_partner-app-appid-user-unblock.md): This API endpoint allows you to unblock one or more WhatsApp users who were previously blocked from sending messages to your WhatsApp Business application. Unblocking restores messaging capabilities, allowing users to send messages again and your app to receive messages from them. This reverses the effect of the block operation. - [Get App's Daily Usage](https://partner-docs.gupshup.io/reference/get_partner-app-appid-usage.md): This API endpoint retrieves detailed usage statistics and billing information for a specific partner application within a specified date range. It provides comprehensive metrics including message counts by category (authentication, marketing, utility, service), fees breakdown (WhatsApp fees, Gupshup fees), billing information (cumulative bill, discount, cap), and conversation counts. This is essential for tracking application usage, billing analysis, and cost management. - [Get App's Daily Discount](https://partner-docs.gupshup.io/reference/get_partner-app-appid-discount.md): This API endpoint retrieves daily discount and billing details for a specific partner application for a given month. It provides comprehensive financial information including Gupshup fees, caps, daily bills, cumulative bills, and discounts applied. This is essential for prepaid account billing analysis, financial tracking, discount verification, and cost management on a day-by-day basis within a specific month. - [Get Profile Details](https://partner-docs.gupshup.io/reference/get_partner-app-appid-business-profile.md): Retrieves the WhatsApp Business profile information for a specific partner application. The business profile contains public-facing information about your business including address, description, email, website, and industry vertical. - [Get Profile About](https://partner-docs.gupshup.io/reference/get_partner-app-appid-business-profile-about.md): This API endpoint retrieves the 'About' text from the WhatsApp Business profile for a specific partner application. The about text is the business description that appears on your WhatsApp Business profile and provides a brief introduction to your business, services, or mission. This is a simplified endpoint that returns only the description text, unlike the full profile endpoint which returns all profile fields. - [Update Profile Details](https://partner-docs.gupshup.io/reference/put_partner-app-appid-business-profile.md): Updates the WhatsApp Business profile information for a specific partner application. You can update multiple profile fields in a single request including address, description, email, website, and industry vertical. All updates are immediately reflected on your WhatsApp Business profile. - [Update Profile About](https://partner-docs.gupshup.io/reference/put_partner-app-appid-business-profile-about.md): Updates the 'About' text (business description) in the WhatsApp Business profile. The about text provides a brief introduction to your business (max 512 characters). This is a simplified endpoint that updates only the description text, completely replacing the existing text. - [Get Profile Picture](https://partner-docs.gupshup.io/reference/get_partner-app-appid-business-profile-photo.md): This API endpoint retrieves the URL of the business profile photo for a specific partner application's WhatsApp Business profile. The profile photo is the visual representation of your business that appears to users when they view your WhatsApp Business profile. This endpoint returns the photo URL which can be used to display or download the current profile photo. - [Update Profile Picture](https://partner-docs.gupshup.io/reference/put_partner-app-appid-business-profile-photo.md): This API endpoint uploads or updates the business profile photo for a specific partner application's WhatsApp Business profile. The profile photo is the visual representation of your business that appears to users when they view your WhatsApp Business profile. This endpoint accepts an image file and sets it as the new profile photo, replacing any existing photo. - [Get Template Analytics for a template](https://partner-docs.gupshup.io/reference/get_partner-app-appid-template-analytics.md): This API endpoint retrieves analytics data for WhatsApp message templates. It provides insights into template performance including messages sent, delivered, read, and button clicks with flexible time ranges and granularity options. - [Enable template analytics setting](https://partner-docs.gupshup.io/reference/post_partner-app-appid-template-analytics.md): This API endpoint enables or disables template analytics settings for a partner application. Template analytics must be enabled before you can retrieve analytics data using the GET template analytics API. - [Disable button click analytics](https://partner-docs.gupshup.io/reference/post_partner-app-appid-template-analytics-buttonclick.md): This API endpoint enables or disables button click analytics for a specific template. Button click tracking allows you to monitor user interactions with buttons in your WhatsApp message templates. This endpoint provides granular control over which templates have button click analytics enabled. - [Template Comparison API](https://partner-docs.gupshup.io/reference/get_partner-app-appid-template-analytics-templateid-compare.md): Use this API to compare templates. This endpoint allows you to analyze and compare the performance of multiple WhatsApp message templates side by side, providing insights into metrics like block rate, message sends, and block reasons. - [Generate Media ID Using File Uplaod](https://partner-docs.gupshup.io/reference/post_partner-app-appid-media.md): Use this API to generate media IDs for WhatsApp messaging by uploading files directly from your local system. Media IDs are required when sending media messages (images, videos, documents, audio) through WhatsApp Business API. - [Generate Media ID Using URL](https://partner-docs.gupshup.io/reference/post_partner-app-appid-media-1.md): Use this API to generate media IDs for WhatsApp messaging by uploading files directly from your local system. Media IDs are required when sending media messages (images, videos, documents, audio) through WhatsApp Business API. - [Download Media](https://partner-docs.gupshup.io/reference/downloadmedia.md): Use this API to download or retrieve media files using their media ID. This endpoint allows you to access media files that were previously uploaded through the Generate Media ID API, enabling you to download images, videos, documents, and audio files. - [Delete media by media ID](https://partner-docs.gupshup.io/reference/delete_partner-app-appid-media-mediaid.md): Permanently deletes a media file from WhatsApp servers using the mediaId. Once deleted, the operation cannot be undone. - [Get Waba Info](https://partner-docs.gupshup.io/reference/getwabahealth.md): Use this API to retrieve comprehensive WhatsApp Business Account (WABA) information and health status for your application. This endpoint provides critical details about account status, messaging capabilities, phone number quality, ownership, and any errors or limitations. **Important Requirements:** - Valid app ID required - App must be WhatsApp Business API enabled - Rate limit: **10 requests per 60 seconds** - PARTNER_APP role mandatory **Common Use Cases:** - Monitor WABA account health and status - Check messaging availability before sending - Verify phone number and quality status - Diagnose account issues and errors - Validate account configuration - Track ownership and account type **Note**: This endpoint provides real-time status information directly from WhatsApp Business API, including any active restrictions or limitations on the account. - [Check Health](https://partner-docs.gupshup.io/reference/get_partner-app-appid-health.md): Use this API to check the health status of your partner application. This endpoint provides a quick way to verify if your application is properly configured and operational within the Gupshup partner platform. - [Get Wallet Balance](https://partner-docs.gupshup.io/reference/get_partner-app-appid-wallet-balance.md): Use this API to retrieve the wallet balance details for your partner application. This endpoint provides current balance, currency, and overdraft limit information for billing and financial monitoring. - [Get Quality Rating](https://partner-docs.gupshup.io/reference/get_partner-app-appid-ratings.md): Use this API to retrieve the quality rating and messaging tier information for your WhatsApp Business API (WABA) application. This endpoint provides insights into your phone number's quality status, current messaging limits, and any recent tier changes. - [Get Templates from the Library](https://partner-docs.gupshup.io/reference/gettemplatesfromlibrary.md): Use this API to fetch pre-approved Meta Library Templates. For common use cases such as delivery updates, account updates and reminders, Meta has now come up with pre-defined utility templates which allows for quick template creation and need not go through approvals as long as there's no change in the description/text of the template (apart from the variables). - [Create Templates from the Template Library](https://partner-docs.gupshup.io/reference/createtemplatefromlibrary.md): API to create template from pre approved Meta Library Template. Use this API to quickly deploy industry-specific, pre-approved templates with customization options, significantly reducing template approval time. - [Whitelist the WABA ID](https://partner-docs.gupshup.io/reference/post_partner-app-appid-obotoembed-whitelist.md): API to whitelist WhatsApp Business Account (WABA) ID for embedded onboarding flow. This endpoint enables partners to whitelist their WABA for the embedded onboarding solution, which is required before attaching credit lines and completing the WhatsApp onboarding process. - [Verify and attach the Credit Line](https://partner-docs.gupshup.io/reference/get_partner-app-appid-obotoembed-verify.md): API to verify and attach the credit line to a whitelisted WhatsApp Business Account (WABA). This endpoint completes the embedded onboarding process by verifying the WABA and attaching the necessary credit line for WhatsApp Business messaging. This is a critical step that must be performed after whitelisting the WABA. - [Get Conversational Component](https://partner-docs.gupshup.io/reference/get_partner-app-appid-conversational-component.md): API to retrieve configured conversational components for WhatsApp Business API. Conversational components are in-chat features that you can enable on business phone numbers. They make it easier for WhatsApp users to interact with your business. You can configure easy-to-use commands, provide pre-written ice breakers that users can tap, and greet first time users with a welcome message. - [Set Conversational Component](https://partner-docs.gupshup.io/reference/post_partner-app-appid-conversational-component.md): API to configure conversational components for WhatsApp Business API. Conversational components are pre-built interactive elements that enable rich, interactive customer experiences with features like quick replies, buttons, lists, and more structured message formats. This endpoint allows you to create and update component configurations for your application. - [Get Templates from Library](https://partner-docs.gupshup.io/reference/gettemplatesfromlibrary_3.md): API to fetch pre approved Meta Library Templates - [Create Template from Template Library](https://partner-docs.gupshup.io/reference/createtemplatefromlibrary_3.md): API to create template from pre approved Meta Library Template - [GIF](https://partner-docs.gupshup.io/reference/creategiftemplate.md): Creates a new GIF template for WhatsApp Business API messaging - [Text](https://partner-docs.gupshup.io/reference/post_partner-app-appid-template-text.md): Use this API to send messages using the Text template. - [Image](https://partner-docs.gupshup.io/reference/post_partner-app-appid-template-image.md) - [Video](https://partner-docs.gupshup.io/reference/post_partner-app-appid-templates-video.md) - [Location](https://partner-docs.gupshup.io/reference/post_partner-app-appid-templates-location.md) - [Product](https://partner-docs.gupshup.io/reference/post_partner-app-appid-templates-product.md) - [Catalog](https://partner-docs.gupshup.io/reference/post_partner-app-appid-templates-catalog.md) - [Carousel (Image)](https://partner-docs.gupshup.io/reference/post_partner-app-appid-templates-carouselimage.md) - [Carousel (Video)](https://partner-docs.gupshup.io/reference/post_partner-app-appid-templates-carouselvideo.md) - [Document](https://partner-docs.gupshup.io/reference/post_partner-app-appid-templates-document.md) - [Limited Time Offer (LTO)](https://partner-docs.gupshup.io/reference/post_partner-app-appid-templates-lto.md): Use this API to create a LTO template. - [Flow](https://partner-docs.gupshup.io/reference/post_partner-app-appid-create-flow-8.md) - [Pix Template ](https://partner-docs.gupshup.io/reference/post_partner-app-appid-templates-8.md): This API creates Pix Templates - [Apply For Templates](https://partner-docs.gupshup.io/reference/post_partner-app-appid-templates-6.md): Using this API, you can Create a template for a particular app - [Get Templates](https://partner-docs.gupshup.io/reference/get_partner-app-appid-templates.md): Using this API you can get the list of templates for a an app. You will get the rejection reason for templates. The response in which inside containerMeta there will be a field correctCategory if meta has identified the miscategorization for this template. - [Apply For Templates with Sample Media](https://partner-docs.gupshup.io/reference/post_partner-app-appid-templates.md): Use this API to create and submit a template along with sample media for your Gupshup App. - [Upload Template Media](https://partner-docs.gupshup.io/reference/post_partner-app-appid-upload-media-1.md): Use this API to upload your sample media and generate a ***handleId*** for it. - [Edit Template](https://partner-docs.gupshup.io/reference/put_partner-app-appid-templates-templateid-1.md): Use this API to edit a template using *templateId*. - [Delete Template](https://partner-docs.gupshup.io/reference/delete_partner-app-appid-template-elementname.md): Use this API to delete a template using the *elementName*. - [Delete Template By Template ID and Element Name](https://partner-docs.gupshup.io/reference/delete_partner-app-appid-template-elementname-templateid.md): Use this API to delete a template using the templateId and elementName. - [Sync Templates for an App](https://partner-docs.gupshup.io/reference/synctemplate.md): This is an app level API used to sync the templates on Gupshup platform - [Partner Portal Onboarding API's](https://partner-docs.gupshup.io/reference/app-onboarding-apis.md) - [Create App](https://partner-docs.gupshup.io/reference/post_partner-app.md): Use this API to create a new WABA onboarding outside of Gupshup UI. - [Update application from Partner Portal](https://partner-docs.gupshup.io/reference/put_partner-app-appid.md): Use this API to update the WABA onboarding outside of Gupshup UI. - [Get app details based on appId](https://partner-docs.gupshup.io/reference/get_partner-app-appid-details.md): Use this API to fetch the app details based on appId. - [Filter and get list of app for the partner](https://partner-docs.gupshup.io/reference/get_partner-app-list.md): Use this API to fetch all the list of apps for the account based on the query parameters. - [Set Contact details for an App](https://partner-docs.gupshup.io/reference/put_partner-app-appid-onboarding-contact.md): Use this endpoint for Contact details. - [Resend verification link](https://partner-docs.gupshup.io/reference/post_partner-app-appid-onboarding-contact-email-resend.md): Use this endpoint to resend verification link. - [Generate Embed Signed Link](https://partner-docs.gupshup.io/reference/get_partner-app-appid-onboarding-embed-link.md): Use this endpoint to generate the embed signed link. - [Mark APP for migration](https://partner-docs.gupshup.io/reference/post_partner-app-appid-onboarding-phonemigration.md): Use this API to mark an app as migrated from another BSP to Gupshup. The flag indicates that this is a migration use case. - [Flow Management](https://partner-docs.gupshup.io/reference/flow-management.md): APIs are available to manage the entire lifecycle flow supported for CAPI apps. - [Create Flow](https://partner-docs.gupshup.io/reference/createflow.md): Use this API to create the flow. - [Get Flow api](https://partner-docs.gupshup.io/reference/getflowbyid.md): Use this API to get flow details by flow Id. - [Get All Flow api](https://partner-docs.gupshup.io/reference/getallflow.md): Use this API to get a list of all flows. - [Update flow](https://partner-docs.gupshup.io/reference/updateflow.md): Use this API to update existing flow. - [Get Flow Json](https://partner-docs.gupshup.io/reference/getflowjson.md): Use this API to get JSON asset. - [Get preview URL](https://partner-docs.gupshup.io/reference/getpreviewurl.md): Use this API to get a preview URL of the flow. - [Delete flow](https://partner-docs.gupshup.io/reference/deleteflow.md): Use this API to delete the flow. - [Deprecate flow api](https://partner-docs.gupshup.io/reference/deprecateflow.md): Use this API to deprecate the flow. - [Publish flow](https://partner-docs.gupshup.io/reference/publishflow.md): Use this API to publish the flow. - [Update Flow Json](https://partner-docs.gupshup.io/reference/updateflowjson.md): Use this API to update the flow json. - [Send Session Message V3 Examples](https://partner-docs.gupshup.io/reference/passthrough-apis.md) - [Document message](https://partner-docs.gupshup.io/reference/senddocumentmessage.md): Send a V3 document message to a WhatsApp user using either a media ID or a hosted link - [Audio Message](https://partner-docs.gupshup.io/reference/post_partner-app-appid-v3-audio-message-6.md) - [Contact Message](https://partner-docs.gupshup.io/reference/post_partner-app-appid-v3-contact-message-6.md): Use this API to send Contact messages - [Flow Message](https://partner-docs.gupshup.io/reference/post_partner-app-appid-v3-flow-message-6.md): Use this API to send message with a flow. - [Image Message](https://partner-docs.gupshup.io/reference/post_partner-app-appid-v3-image-message.md): Use this API to send an image message to a WhatsApp user. - [Interactive Message](https://partner-docs.gupshup.io/reference/post_partner-app-appid-v3-interactive-message.md): Use this API to send the interactive messages to WhatsApp users. - [Reaction Message](https://partner-docs.gupshup.io/reference/post_partner-app-appid-v3-reaction-message.md): Use this API to send a reaction message to a WhatsApp user. - [Sticker Message](https://partner-docs.gupshup.io/reference/post_partner-app-appid-v3-sticker-message.md): Use this API to send a sticker messages. - [Text Message](https://partner-docs.gupshup.io/reference/post_partner-app-appid-v3-text-message.md): Use this API to send a text message to a WhatsApp user. - [Video Message](https://partner-docs.gupshup.io/reference/post_partner-app-appid-v3-video-message.md): Use this API to send a video message to a WhatsApp user. - [PIX Session Message](https://partner-docs.gupshup.io/reference/post_partner-app-appid-v3-message-8.md) - [PIX Template Message](https://partner-docs.gupshup.io/reference/post_partner-app-appid-v3-message-7.md) - [Boleto Message](https://partner-docs.gupshup.io/reference/boleto-message.md): Use this API to send a boleto message to a WhatsApp user. - [Payment Link Message](https://partner-docs.gupshup.io/reference/payment-link-message.md): Use this API to send a payment link message to a WhatsApp user. - [Send interactive call permission request message](https://partner-docs.gupshup.io/reference/post_partner-app-appid-v3-message-16.md): Use this API to send a Interactive CPR Message to a WhatsApp user. - [Voice Notes Message](https://partner-docs.gupshup.io/reference/voice-notes-message.md): Use this API to send a Audio Voice Notes Message to a WhatsApp user. - [Location request messages](https://partner-docs.gupshup.io/reference/post_partner-app-appid-v3-message-17.md): Location request messages display body text and a send location button. When a WhatsApp user taps the button, a location sharing screen appears which the user can then use to share their location. - [Send Product Card Message](https://partner-docs.gupshup.io/reference/post_partner-app-appid-v3-message-18.md): The interactive product carousel message enables businesses to send horizontally scrollable product cards within WhatsApp conversations, allowing users to browse and engage with products directly in-thread. - [Send Media Card Carousel Message](https://partner-docs.gupshup.io/reference/post_partner-app-appid-v3-message-19.md): Interactive media carousel messages display a set of horizontally scrollable media cards. Each card can display an image or video header, body text, and either quick-reply buttons or a URL button. - [Text-Based Message](https://partner-docs.gupshup.io/reference/post_partner-app-appid-v3-message-14.md): Use this API to send messages using the Text based message. - [Authentication-based Message Templates](https://partner-docs.gupshup.io/reference/post_partner-app-appid-v3-message-9.md): Use this API to send approved authentication templates with one-time password buttons. - [Interactive Message Templates](https://partner-docs.gupshup.io/reference/post_partner-app-appid-v3-message-10.md) - [Location-based Message Templates](https://partner-docs.gupshup.io/reference/post_partner-app-appid-v3-message-11.md): Use this API to send a template that uses a location header your request must include a location header object. - [Media-Based Message Template](https://partner-docs.gupshup.io/reference/post_partner-app-appid-v3-message-12.md): Use this API to send a media based message as template. - [Multi-Product Template Messages](https://partner-docs.gupshup.io/reference/post_partner-app-appid-v3-message-13.md): Use this API to send multi-product message (MPM) templates in template messages. - [Send Flow Message](https://partner-docs.gupshup.io/reference/post_partner-app-appid-v3-message-6.md): Use this API to send message with a flow. - [Text](https://partner-docs.gupshup.io/reference/text-1.md) - [Media](https://partner-docs.gupshup.io/reference/media-1.md) - [Interactive](https://partner-docs.gupshup.io/reference/interactive-1.md) - [Send Product Card Carousel Template](https://partner-docs.gupshup.io/reference/post_partner-app-appid-v3-message-4.md): Use this API to send product card carousel as template - [Boleto Template Message](https://partner-docs.gupshup.io/reference/boleto-template-message.md): Use this API to send a boleto template message to a WhatsApp user. - [Payment Link Template Message](https://partner-docs.gupshup.io/reference/payment-link-template-message.md): Use this API to send a payment link template message to a WhatsApp user. - [Send msg With Template ID](https://partner-docs.gupshup.io/reference/post_partner-app-appid-template-msg.md): Use this API to send messages with Template ID. - [v2 Send Template Message Examples](https://partner-docs.gupshup.io/reference/send-message-examples.md) - [GIF](https://partner-docs.gupshup.io/reference/sendgiftemplatemessage.md): This API is used to send messages with the GIF template. - [Text](https://partner-docs.gupshup.io/reference/post_partner-app-appid-template-msg-1.md): Use this API to send messages using the Text template. - [Image](https://partner-docs.gupshup.io/reference/post_partner-app-appid-template-msg-4.md): Use this API to send messages with an Image template. - [Video](https://partner-docs.gupshup.io/reference/post_partner-app-appid-template-msg-3.md): Use this API to send messages via video templates. - [Location](https://partner-docs.gupshup.io/reference/post_partner-app-appid-msg.md): Use this API to send messages with the Location template. - [Product](https://partner-docs.gupshup.io/reference/post_partner-app-appid-template-msg-9.md): Use this API to send message with the Product template. - [Catalog](https://partner-docs.gupshup.io/reference/post_partner-app-appid-template-msg-5.md): Use this API to send messages with a Catalog template. - [Carousel (Image)](https://partner-docs.gupshup.io/reference/post_partner-app-appid-template-msg-8.md): Use this API to send messages with the Carousel template (Image). - [Carousel (Video)](https://partner-docs.gupshup.io/reference/post_partner-app-appid-template-msg-7.md): Use this API to send messages with the Carousel template (Video). - [Document](https://partner-docs.gupshup.io/reference/post_partner-app-appid-template-msg-2.md): Use this API to send messages using the Document template. - [Limited Time Offer (LTO)](https://partner-docs.gupshup.io/reference/post_partner-app-appid-template-msg-6.md): Use this API to send messages with the LTO template. - [Send MM Lite message with GIF template](https://partner-docs.gupshup.io/reference/sendmmlitegiftemplatemessage.md): Sends a marketing WhatsApp message using a GIF-based template. - [Get template Ad details](https://partner-docs.gupshup.io/reference/gettemplateaddetails.md): This API returns the details around the marketing template Ad account. - [Get template Ad Insight](https://partner-docs.gupshup.io/reference/gettemplateinsights.md): This API returns the details around the marketing template insights. - [Enable MM Lite messages](https://partner-docs.gupshup.io/reference/post_app-appid-mmlite-msg-enable.md): Use this API to enable MM-lite messaging for a live app that has already been onboarded for mm-lite. - [Get MM Lite link on-boarding for live app](https://partner-docs.gupshup.io/reference/getmmlitelink.md): Use this API to Get MM Lite Onboarding link. - [MM Lite Send Message](https://partner-docs.gupshup.io/reference/mmlitesendmessage.md): Use this API to send MM Lite message. - [WhatsApp Voice call enable disable API](https://partner-docs.gupshup.io/reference/post_partner-app-appid-voice.md): This API is used to enable/disable voice functionality at app level. - [Get WhatsApp Profile Display Name](https://partner-docs.gupshup.io/reference/getprofilename.md): This API retrieves the current display name for a WhatsApp application. - [Update WhatsApp Profile Display Name](https://partner-docs.gupshup.io/reference/updateprofilename.md): This API updates the display name for a WhatsApp application. - [Delete template by element name](https://partner-docs.gupshup.io/reference/delete-template-by-element-name.md): API to delete template by element name - [Initiate Contacts/History Synchronization](https://partner-docs.gupshup.io/reference/initiatecoexsync.md): Initiates one-time synchronization for the app. - Use `syncType=smb_app_state_sync` to initiate contacts synchronization. On success, `smb_app_state_sync` webhooks are triggered for current contacts and future contact updates. - Use `syncType=history` to initiate message history synchronization. If the business has shared history, `history` webhooks are triggered. Important: - This step can be performed only once. - To perform again, customer must offboard and complete Embedded Signup again. - [Bulk Update App Configuration](https://partner-docs.gupshup.io/reference/updatepartnerappconfig.md): Use this API when you need to roll out the **same setting across all WhatsApp apps** under your partner account — for example, enabling a feature flag for every linked app. **How it works** 1. Submit the configuration you want applied, along with your Partner ID. 2. You receive instant confirmation and the total number of apps queued. 3. Updates run in the background — you do not need to wait on the API call. 4. The partner admin receives an email when processing completes. **Important:** There is no job tracking ID. The completion email is how you know the update has finished. **Email outcomes** - All apps succeed → success email with summary counts; no attachment. - Some apps fail → email with summary plus a CSV listing failed app IDs and error reasons. **Access:** Partner Admin or Partner User. Partner ID must match your logged-in account. Rate limit: 1 requests per 60 seconds. - [Set / adopt business username](https://partner-docs.gupshup.io/reference/setbusinessusername.md): Adopts or changes the business username for the app's WhatsApp phone number. - [Get current business username](https://partner-docs.gupshup.io/reference/getbusinessusername.md): Returns the business username and status for the app's phone number. - [Delete business username](https://partner-docs.gupshup.io/reference/deletebusinessusername.md): Deletes the business username associated with the app's phone number. - [Get reserved username suggestions](https://partner-docs.gupshup.io/reference/getbusinessusernamesuggestions.md): Returns reserved username suggestions for the business portfolio (higher chance of approval). A suggestion can be claimed via Set / Adopt Business Username. ## Changelog - [August 2026](https://partner-docs.gupshup.io/changelog/august-2026.md) - [October 2026](https://partner-docs.gupshup.io/changelog/october-2026.md) - [July 2026](https://partner-docs.gupshup.io/changelog/july-2026.md) - [June 2026](https://partner-docs.gupshup.io/changelog/june-2026.md) - [May 2026](https://partner-docs.gupshup.io/changelog/may-2026.md) - [April 2026](https://partner-docs.gupshup.io/changelog/april-2026.md) - [March 2026](https://partner-docs.gupshup.io/changelog/march-2026.md) - [February 2026](https://partner-docs.gupshup.io/changelog/february-2026.md) - [January 2026](https://partner-docs.gupshup.io/changelog/january-2026.md) - [December 2025](https://partner-docs.gupshup.io/changelog/december-2025.md)