Partner Portal

These release notes describe the new feature updates, bug fixes, performance improvements, known issues, and other important information for the Partner Portal

Change in URL (Coming Soon)

Gupshup partner portal will soon be moved from www.gupshup.io/partner to https://partner.gupshup.io/

/sm Endpoint End of Life by 15th August extended to 31st October 2024 for existing On-Premise and Cloud API apps

Read this article to learn more

Optin Optout Service - End of Life by 31st Aug 2024 for existing On-Premise and Cloud API apps

As informed previously, we advise partners to NOT register optin optouts via any single/bulk upload APIs. Partners must manage opt-in opt-out data at their end. You must also prepare for the end of life for any Gupshup opt-in opt-out endpoints you use by 31st Aug 2024. This will result in failure in response to these APIs after the deadline. We recommend you store final list of opt-in opt-outs before the deadline.

Please read more about it here.

Version 11.0 Release Date: 26 August 2024

Overall Summary

Partner Vault tab to added in partner portal

  • Added a new Vault section to the Partner Portal in the Resource tab. You can make the most out of working with Gupshup with the resources shared in Vault.

Upload media or use URL to generate media ID (CAPI only)

  • APIs to generate media ID, using file upload or URL, are only available to partners on CAPI.

Removed media SKUs from UI, API, PDF, CSV

  • To streamline the data presentation, we have removed media SKUs from the UI, API, PDF, and CSV exports.

Detailed Notes

Partner Vault added in partner portal

To enhance the Partner Portal, a new tab Vault is added to the dropdown list of Resources tab. This tab provides access to the vault link at gupshup.io/partner-vault/, adding to the resources available to partners for better engagement and support. You can make the most out of working with Gupshup with the resources shared in Vault.

Upload media or use URL to generate media ID (CAPI only)

APIs to generate media ID, using file upload or URL, are only available to partners on CAPI. Read how to Generate Media ID.

Removed media SKUs from UI, API, PDF, CSV

To streamline the data presentation, we have removed media SKUs from the UI, API, PDF, and CSV exports. The media messages will be counted under template sent and session sent columns now. Refer to API.



Version 10.5 Release Date: 29 July 2024

Overall Summary

Feedback capturing improved in the Partner Portal

  • Partners can now attach screenshots and video recordings along with their feedback on the Partner Portal.

WABA Info

  • The API offers a comprehensive messaging status for live applications, showing their availability as Available, Limited, or Blocked. It also provides detailed statuses at the WABA, Business, and app levels.

Meta Utility Template Library

  • Meta has introduced pre-defined utility templates for common use cases like delivery updates, account updates, and reminders, allowing quick template creation without requiring approvals, as long as there are no additional checks in the template description or text, except for variables.

Detailed Notes

Feedback capturing improved in the Partner Portal

This document outlines the feedback captured in the Partner Portal.

  1. Users can now provide feedback to communicate their specific issues or suggestions for the product and categorize it as a bug or a feature request by selecting from the dropdown list.
  2. Partners now have the ability to provide feedback in the formats below:
    • Attach/upload files (.mp4 .avi .wmv .jpg, .jpeg .svg .png).
    • Attach screen recordings up to 15 MB.
  3. The maximum file size for attachments, including screenshots and screen recordings, is increased to 15 MB. This ensures that partners can easily upload and share their files without any limitations.

WABA Info

The API provides messaging status information for live apps, including overall status (Available, Limited, Blocked), as well as individual status at the WABA (WhatsApp Business Account), Business, and app levels.

If the messaging status is Limited, the API will send an "Additional_info" node. If the messaging status is Blocked, the API will send an "errors" node, which includes information such as error code, error description, and possible solution. Refer to WABA Info API for more information.

Meta Utility Template Library

Meta library is updated with pre-defined Utility Templates for common use cases like delivery updates, account updates, and reminders.

These templates allow for quick creation without the need for approvals, as long as there are no changes in the template's description or text, apart from the variables.

This enhancement streamlines the template creation process for users, making it easier to communicate important information efficiently. Refer to the APIs.

Version 10.0 Release Date: 08 July 2024

Overall Summary

User Management for Partner Portal

  • Partner users can now grant access/revoke access to the partner portal users. They can also permanently delete a user as well. This functionality is only available to partner portal admins.

Support of Thread Builder Link on Partner Portal

  • We've added a new text message to the Apps Page to help you create custom templates. The text is as follows:

“Create mocks and template previews with the WhatsApp Thread Builder”

📘

Note:

For new users, the text will only be displayed on the Apps page.

Support for 100 MB Media Upload

  • Partners can now upload media files up to 100MB for HandleID and Media ID with this update.

Delete template by ID and Element Name

  • You can now delete templates by passing the template ID and the element name. You can read more about the API here.

Reminder email to submit solution details

  • Partners who have not submitted their solution request details will be prompted to submit their solution details

Get Template API Update

  • We updated the response for the Get Template API. The API response will now include two new fields: new_category and correct_category. During this process, Meta will send two webhook events for template_category_update. Know more

Detailed Notes

User Management for Partner Portal

Partner users can now revoke access/grant access to other partner users. They can also permanently delete partner portal users. This functionality is only available to partner portal admins.

In case a partner user’s access is revoked, the user's status will change from Active to Suspended.

In case if access is restored to the user, the status will change back to Active.

Upon clicking on the delete icon, the user will be permanently deleted as a partner portal user. A confirmation message will be displayed, and once the user clicks on delete. The user will be permanently deleted from the partner portal.

Support of Thread Builder Link on Partner Portal

As shown in the below image, a redirection link has been added to the Partner Portal Apps page.

Whatsapp thread builder is a prototyping tool, which can be used by partners to create their mocks and template previews. It can be accessed after Facebook login.

Get Template API Update

Starting from June 1, 2024, Meta has implemented a recurring process to automatically identify and update the category of any marketing or utility templates that have been miscategorized, according to their guidelines, to ensure that all templates are correctly categorized.

In this process, meta will now send two webhook events for template_category_update.

  1. The first one is the alert event which informs about the template’s current category and the correct category it belongs to.
  2. The second event (sent on the 1st of the next month after the alert event) is the actual category update event informing that the template’s category has now been updated.

For more information, refer to the link.

Delete template by ID and element name

We have the API to delete templates by passing the template ID and the element name. You can read more about the API here.

Reminder email to submit solution details

Partners who have not submitted their solution request details will be prompted to submit their solution details. This email will be sent to the partners.


Version 9.5 Release Date: 18 June 2024

Overall Summary

Wallet Page to be the Default Landing Page

  • If a wallet is not created for any new partner, the user will land on the Wallet page, by default. From there the user can create a wallet and then an app.

Support of the International Authentication tab on the Analytics Page

  • We've added a new SKU for International Authentication on the Analytics page. This SKU shows values on the pie chart. If the value is zero, it won't be shown. You can also find these values in the PDF reports under the Conversation > Int Auth tab, and in the CSV file under the International Authentication tab.
  • We have updated the response for the public Get App's Daily Usage API as well.

Redirection from Partner Portal to Gupshup Documentation

Note added to Analytics Page

  • Under the Note section on the Analytics page, a new text has been added, which is as follows:

“All results are shown as per IST timezone”.

Resubmission of Solution ID for existing ISVs

  • The partner will now have the option to resubmit a new Solution ID if the previous one gets rejected. This feature is accessible on the Settings Page.
  • When the user submits a new Solution ID, the status will change to “PENDING” and the approval request will be sent to the Partner Support Team.

Addition of EXPIRED state on Commission page

  • A new "EXPIRED" state has been added under the status tab on the Commission page. This indicates expired credits in wallets as per the Commission Policy

Partner API Conversational Components

Health Check API Update

  • We updated the response for the Health Check API. This API indicates WABA health as healthy if accountStatus is ACTIVE and dockerStatus is CONNECTED or MIGRATED.
  • Click here, to learn more about Health Check API.

Get Quality Rating Update

  • We've updated the response for the Get Quality Rating API. The API response will now include a new field called Phone Quality, with the following possible values:
    • Green: High quality
    • Yellow: Medium quality
    • Red: Low quality
  • Click here, to learn more about Get Quality Rating API.

Bug Fixes on wallet

  • The wallet statement downloaded will be in Asia/Kolkata timezone , and the note has been added on the email statement pop up

  • The pricing for Kazakhstan customers for Meta fees will be as per other country rates in Meta Rate card going forward

Detailed Notes

Support of the International Authentication tab on the Analytics Page

A new SKU for International Authentication has been introduced on the Analytics page. This SKU shows values on the pie chart. If the value is zero, it won't be shown. You can also find these values in the PDF reports under the Conversation > Int Auth tab, and in the CSV file under the International Authentication tab.

We have updated the response for the public Get App Usage API accordingly.

Partners can view International Authentication analytics under the Total Conversation card

Partners can view International Authentication analytics under the Total Conversation card

Addition of EXPIRED state on Commission page

We have introduced a new state called "EXPIRED" under the status tab on the Commission page. This indicates expired credits in a wallet.

Partner API Conversational Components

With the addition of new Conversational Component APIs, partners will be able to configure the ice breakers and send welcome messages. It supports up to 4 ice breakers, each with a maximum of 80 characters.

Version 9.1 Release Date: 3 June 2024

Overall Summary

Existing Partners can now become tech providers with Gupshup

  • Existing partners can now add joint solution ID via the settings page in the Partner Portal

Partner Admins can now toggle apps for their own usage

  • Partners can modify sandbox apps to mark them for their own usage. When these apps go live, they will not have any solution ID mapped with them.

Overdraft Automation for wallet

  • Gupshup will now calculate the overdraft limit that is available to its users based on their past usage.
  • Users can assign their overdraft limit between 0 and the Gupshup calculated limit, this limit will be applicable to their wallets immediately

Meta fees to be deducted on delivery instead of sent

  • Updated the Meta fee deduction policy

International authentication pricing rollout

  • Based on the eligibility criteria, the customers will be charged international authentication prices

Detailed Notes

Existing Partners can now become Tech Providers with Gupshup

● Existing Partners can now enter their solution ID on the partner portal and submit it for Gupshup approval . Read more about this feature here

Partner can add new joint solution from their settings menu

Partner can add new joint solution from their settings menu

Once the partner clicks on submit for approval, the above message is shown to the partner

Once the partner clicks on submit for approval, the above message is shown to the partner

The status of the solution remains pending till Gupshup approves it

The status of the solution remains pending till Gupshup approves it

  • Once the solution is approved, the status is changed to approved in the settings page.
  • Please note that the apps going live after the approval of the solution ID by Gupshup are mapped with the added solution ID.
  • The only exception is the apps that the partners have for their own use, and which are specified in the app properties.
  • How to make apps live with this Joint Solution ID? Read here.

Partner Admins can now toggle apps for their own usage

  • Partner Admins can now toggle apps for their own usage (or have the apps as demo apps) by modifying the app properties clicking on the pencil icon on the Apps page on Partner portal. This allows the app to go live without any joint solution. Read more about this feature here.
Partners can modify the app properties by clicking on the pencil icon

Partners can modify the app properties by clicking on the pencil icon

  • The partner can toggle on the button to mark this app for their own usage.
  • For tech providers with an approved solution ID added, in case the partner toggles the button on, the app once it goes live, will not have any solution ID mapped to the app.
  • This can only be done for sandbox apps , once an app goes live, its app properties can not be modified.
Partner can mark apps for their own usage

Partner can mark apps for their own usage

Overdraft Automation for Wallet

Gupshup will now calculate the overdraft limit that is available to its users based on their past usage.

Overdraft Calculation:

The overdraft limit is a dynamic value determined by the following factors:

  1. Current/Assigned Overdraft: This is the user's current overdraft limit, set by support.
  2. Recharge History: The sum of all recharges made by the user over the past 90 days.
  3. Opening Balance: The user's account balance at the beginning of the 90-day window.
  4. Consumption History: The total amount spent from the wallet over the past 90 days.
    Read more about Gupshup's assigned Overdraft.

Meta fees to be deducted on delivered instead of sent

Meta fees will be deducted based on delivered or read events instead of sent events. This change is designed to align the fee structure with Meta.

There will be no change in the billing events.

International authentication Pricing

For customers in Indonesia from June 1st 2024, and India from July 1st 2024, the international authentication would be charged if applicable. This is applicable if customers send authentication conversations to a different country. This is applicable after 750K conversations are crossed in a month. You can read more about this here.

Version 9.0 Release Date: 21 May 2024

Overall Summary

Addition of Customer ID column to the Analytics Page

  • A new column, Customer ID, has been added to the Analytics Page to track self-serve Customer ID or Wallet-wise analytics per app.

Solution Name now Support Spaces

  • Partners can now enter solution names with spaces, for example, solution test if the name set in the Meta Developer Portal was the same.

Tech Provider Guide added on Partner Sign-up Page

  • A new icon, Know How to Get Your Solution ID, has been added to the Partner Signup page. This functionality assists partners in learning how to obtain their solution ID before proceeding with the signup on the Partner Portal.

Embed Flow will only support CAPI (FBC) Hosting

  • Partners will only view the FBC hosting option when taking an app live. WABAs will be onboarded on CAPI(Cloud API) going forward for partners.

Detailed Notes

Addition of Customer ID column to the Analytics Page

Customer ID will now be available against the apps listed on the analytics page on the Partner Portal. It will also be available on the reports downloaded from the analytics page in the partner portal.

The response for the GET Partner Apps API has also been modified to include customer ID.

Added below is the screenshot for reference.

Solution Name now Support Spaces

The solution name field now supports spaces.

📘

Note:

An "i" icon has been added with the text "Exact name of the solution as created in the partner solutions on the Meta developer platform".

Tech Provider Guide added on Partner Signup Page

To make it easier for partners to sign up on the Gupshup partner portal, the tech provider guide is now embedded in the partner sign-up page.

Embed Flow will only support CAPI (FBC) Hosting

Partners will only view the FBC hosting option when taking an app live. WABAs will be onboarded on CAPI(Cloud API) going forward for partners.

Version 8.5 Release Date: 17 April 2024

Overall Summary

API for Template Comparison

  • Users can now compare actions on the Template list with the API.

Traversing to the Previous Step During Partner Setup

  • A back button has been added to the Go Live UI, enabling users to navigate back to the previous step easily during partner setup.

Detailed Summary

API for Template Comparison

The API allows comparison of two templates by examining how often each one is sent, which one has the lower ratio of blocks to sends, and each template's top reason for being blocked.

Prerequisites

  • Only two templates can be compared at a time for now.
  • Both templates must be in the same WhatsApp Business Account.
  • Templates must have been sent at least 1,000 times in the queries specified timeframe.
  • Timeframes are limited to 7, 30, 60, and 90-day lookbacks from the time of the request.
    start time < end time.

Click here, to read more about Template Comparison APIs.

Traversing to the Previous Step During Partner Setup

Partners can review and make changes before final submission if necessary. They can do so by clicking on the back button or clicking on the green stepper to navigate to the previous step.

Version 8.0 Release Date: 26 March 2024

Overall Summary

Improved Commission Payouts for Tech Provider partners

  • Commission Payout to the wallet would only be available to those partners for whom the wallet is enabled. Tech Provider Partners can easily move their commission to their wallets by choosing the preferred wallet on the partner portal.
  • Similarly, for setting recurring payouts, partners can now choose the wallet to which they want to move the commission.
  • New and Improved partner docs available at docs.gupshup.io

Detailed Notes

Improved commission payouts for partners

  • Partners can now move their commission to their wallets. Simply, select the wallet where you would like to move your commission.
  • The list of your partner wallets will be visible on the withdraw commission pop-up.
  • Similarly for setting recurring payouts, the partners can choose the wallet to which the commission needs to be moved.

New and Improved partner docs available

  • New and Improved partner docs are available at docs.gupshup.io
  • Guides, API References, and Release Notes will be available for partners from March 26th onwards.
  • We will keep updating our partner docs

Version 7.5 Release Date: 6 March 2024

Overall Summary

Partner Setup Enhancements

  • Tech providers must now provide their Solution ID and Solution Name during partner sign-up.
  • You can refer to the partner setup tab to understand your progress while setting up the partner portal

Detailed Notes

TPP Partner Setup Enhancements

  1. Simple Partner Application

During the partner application step, partners must submit the following fields:

a. Solution ID

b. Solution Name

Partners need to submit their Solution ID and Solution Name during partner setup

Partners need to submit their Solution ID and Solution Name during partner setup

Version 7.0 Release Date: 19 Feb 2024

Overall Summary:

TPP Partner Onboarding Enhancements

  • Simple Partner Application - Reduced number of inputs for partner application
  • Re-Submit Partner Creation Request - Ability to submit partner creation request with modified meta app ID details, if the support team has rejected the partner creation request
  • Meta App ID Screenshot - Partners need to submit a Meta App ID screenshot during the partner creation process

Allowing URLs to be submitted in media upload API ( handle ID, and media ID )

  • Partners can now submit URLs in the media upload API

Detailed Notes :

TPP Partner Onboarding Enhancements

  1. Simple Partner Application

During the partner application step, partners now need to submit the following fields

  • Registered Business Name
  • Registered Business Address
  • Nature of Service Provided
  • ISV FB Manager

Revised partner application step in the partner creation process

  1. Resubmit Partner application in case of Rejection

If partner support rejects the partner application, partners can now submit their partner application with modified Meta App ID details.

Screen in case the partner application is rejected during the partner creation process

Screen in case the partner application is rejected during the partner creation process

Screen for the partner to resubmit the partner application, once the partner clicks on resubmit

Screen for the partner to resubmit the partner application, once the partner clicks on resubmit

  1. Meta App ID screenshot to be uploaded

Partners need to submit a mandatory screenshot detailing the following, during the partner creation application.

The supported format types for the screenshot are SVG, JPEG, JPG, and PNG.
The screenshot should contain the following information, which should be visible

  • App Name
  • Meta App ID
  • Email address of Partner
  • Whatsapp product added to app
Screen to upload Meta App ID screenshot during the partner creation process

Screen to upload Meta App ID screenshot during the partner creation process

Sample screen that needs to be submitted by partner

Sample screen that needs to be submitted by partner


Allowing URLs to be submitted in media upload API

We now support submitting video/Image URLs in the media Upload API, with handle ID