Gupshup Partner

https://partner-docs.gupshup.io/reference
Admin
Provides a comprehensive set of APIs for Gupshup partners to manage their applications, templates,...
Tokens:202,701
Snippets:720
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Subscription Response Examples

Source: https://partner-docs.gupshup.io/reference/get_partner-app-appid-subscription-subscriptionid

Examples of successful and error responses returned by the API.

```json
{
  "status" : "success",
  "subscription" : 
  {
    "active" : true,
    "appId" : "657c0203-0b4d-4ba1-bbf5-a679cfa35a16",
    "createdOn" : 1739862125507,
    "id" : "32595",
    "latencyBucket" : "lt_1_s",
    "mode" : 1025,
    "modes" : [ "SENT", "ENQUEUED" ],
    "modifiedOn" : 1739870558358,
    "showOnUI" : false,
    "tag" : "V33i4",
    "url" : "https://01hqjda5pbywgv7xw5e9ckd5e800-51132d4cc32709e9078d.requestinspector.com",
    "version" : 2
  }
}
```

```json
{

        "status" : "success","subscription" :
        {
        "active" : true,
        "appId" : "657c0203-0b4d-4ba1-bbf5-a679cfa35a16",
        "createdOn" : 1739862125507,
        "id" : "32595",
        "latencyBucket" : "lt\_1\_s",
        "mode" : 1025,
        "modes" : [ "SENT", "ENQUEUED" ],
        "modifiedOn" : 1739870558358,
        "showOnUI" : false,
        "tag" : "V33i4",
        "url" : "[https://01hqjda5pbywgv7xw5e9ckd5e800-51132d4cc32709e9078d.requestinspector.com](https://01hqjda5pbywgv7xw5e9ckd5e800-51132d4cc32709e9078d.requestinspector.com)",
        "version" : 2
        }
        }
```

```json
{

        "status": "error","message": "API key is not associated with partner"
        }
```

```json
{

        "status": "error","message": "Subscription Does Not Exist"
        }
```

```json
{

        "status": "error","message": "Authentication Failed"
        }
```

```json
{

        "status": "error","message": "Not Subscription Owner"
        }
```

```json
{

        "status": "error","message": "Too Many Requests"
        }
```

--------------------------------

### Get App Usage Response

Source: https://partner-docs.gupshup.io/reference/get_partner-app-appid-usage

Example JSON response containing a list of daily usage metrics for the requested application.

```json
 {
    "status": "success",
    "partnerAppUsageList": [
        {
            "appId": "bf9ee64c-3d4d-4ac4-8668-732e577007c4",
            "appName": "Jan10pass",
            "authentication": 0,
            "cumulativeBill": 0.007,
            "currency": "USD",
            "date": "2024-01-10",
            "discount": 0.0,
            "fep": 0,
            "ftc": 1,
            "gsCap": 75.0,
            "gsFees": 0.007,
            "incomingMsg": 2,
            "outgoingMsg": 4,
            "outgoingMediaMsg": 0,
            "marketing": 0,
            "service": 0,
            "templateMsg": 0,
            "templateMediaMsg": 1,
            "totalFees": 0.007,
            "totalMsg": 7,
            "utility": 0,
            "waFees": 0.0,
            "internationalAuthentication": 1
        },
        {
            "appId": "bf9ee64c-3d4d-4ac4-8668-732e577007c4",
            "appName": "Jan10pass",
            "authentication": 0,
            "cumulativeBill": 0.234,
            "currency": "USD",
            "date": "2024-01-18",
            "discount": 0.0,
            "fep": 0,
            "ftc": 1,
            "gsCap": 75.0,
            "gsFees": 0.091,
            "incomingMsg": 9,
            "outgoingMsg": 82,
            "outgoingMediaMsg": 0,
            "marketing": 1,
            "service": 0,
            "templateMsg": 0,
            "templateMediaMsg": 0,
            "totalFees": 0.101,
            "totalMsg": 91,
            "utility": 0,
            "waFees": 0.01,
            "internationalAuthentication": 1
        }
    ]
}
```

--------------------------------

### Template Schema Examples

Source: https://partner-docs.gupshup.io/reference/post_partner-app-appid-templates

Examples of JSON schema fields for template configuration, including content, buttons, and authentication settings.

```json
"example": "TEXT"
```

```json
"vertical": {
  "type": "string",
  "description": "Character limit: 180",
  "example": "TEXT"
}
```

```json
"content": {
  "type": "string",
  "description": "The body of the template. Character limit: 1028. For “Authentication” category the first line should be - {{1}} is your verification code.",
  "example": "your ticket has been confirmed for {{1}} persons on date {{2}}."
}
```

```json
"header": {
  "type": "string",
  "description": "Header of the template. Applicable for templateType = Text Character limit: 60. Not applicable for “Authentication” category.",
  "example": "This is the header"
}
```

```json
"footer": {
  "type": "string",
  "description": "Footer of the template. Character limit: 60. Not applicable for “Authentication” category, only set based on code_expiration_minutes value",
  "example": "This is the footer"
}
```

```json
"buttons": {
  "type": "string",
  "description": "Used only if your template has a CTA. An example is also submitted if a URL button has variable parameter. For “Authentication” category OTP button type is supported with two otp_type:\n1. COPY_CODE\n2. ONE_TAP\nIf otp_type is set to ONE_TAP, three additional parameters are required:\n\n1. autofill_text\n2. package_name\n3. signature_hash",
  "example": "[{\"type\":\"PHONE_NUMBER\",\"text\":\"Call Us\",\"phone_number\":\"+919872329959\"},{\"type\":\"URL\",\"text\":\"Book A Demo\",\"url\":\"https://bookins.gupshup.io/{{1}}\",\"example\":[\"https://bookins.gupshup.io/abc\"]}] or for “Authentication” category: [{\"type\":\"OTP\",\"otp_type\":\"COPY_CODE\",\"text\":\"Copy OTP\"},{\"type\":\"OTP\", “otp-type”: “ONE_TAP”, \"text\":\"Book A Demo\", \"autofill_text\": \"Autofill\", #One-tap buttons only \"package_name\": \"com.example.myapplication\" #One-tap buttons only , \"signature_hash\": \"K8a%2FAINcGX7\", #One-tap buttons only }]"
}
```

```json
"example": {
  "type": "string",
  "description": "An example of the template.",
  "example": "your ticket has been confirmed for 4 persons on date 2020-05-04."
}
```

```json
"enableSample": {
  "type": "boolean",
  "description": "Required for creating all types of templates.",
  "example": "true"
}
```

```json
"allowTemplateCategoryChange": {
  "type": "boolean",
  "description": "Boolean value. If True, Meta will automatically update the category of the template as per the template content. Default value is False. If the category gets updated, you can view the oldCategory from the Get Templates API",
  "example": "false"
}
```

```json
"exampleHeader": {
  "type": "string",
  "example": "This is the header"
}
```

```json
"addSecurityRecommendation": {
  "type": "boolean",
  "description": "Optionally for \"Authentication\" category a security disclaimer is added to content - For your security, do not share this code",
  "example": "true"
}
```

```json
"codeExpirationMinutes": {
  "type": "integer",
  "description": "Optionally for “Authentication” category the following text is added to footer - This code expires in <NUM_MINUTES> minutes. Code expiry time should be between 1 and 90 minutes.",
  "example": "2"
}
```

--------------------------------

### Success Response Example

Source: https://partner-docs.gupshup.io/reference/get_partner-app-list

Example of a 200 OK response body returned upon successful retrieval of the application list.

```json
{       [{           "id": "\<app_id>",           "name" : "\<app_name>",           "type" : "\<app_type>",           "live": <true/false>,           "phone" : <phone_number_with_country_code>,           "stopped": <true/false>,           "storageRegion" : "\<BR, DE, CH, GB, BH, ZA, AE, US, CA, AU, ID, IN, JP, SG, KR>",           "uiFormStage" : <>,           "pipelineStage" : <>,           "creationStage" : <>,           "whatsappVerificationStatus" : <>,           "version": <0,1,2>,           "products" : ["ANALYTICS", "CUSTOMER_SUPPORT"],           "createdOn": <epoch_timestamp>,           "modifiedOn": <epoch_timestamp>       }],       "status": "success"   }
```

--------------------------------

### Sample JSON response for Get All Flows

Source: https://partner-docs.gupshup.io/reference/getallflow

Example of the successful response body containing a list of flow objects.

```json
[
    {
        "categories": [
            "APPOINTMENT_BOOKING"
        ],
        "id": "460785803057688",
        "name": "Message templates_delivery_failed_form_1_APPOINTMENT_BOOKING_93375",
        "status": "PUBLISHED",
        "validation_errors": []
    },
    {
        "categories": [
            "SIGN_UP"
        ],
        "id": "881255207342075",
        "name": "Message templates_temp_signup_form_MARKETING_e7589",
        "status": "PUBLISHED",
        "validation_errors": []
    },
    {
        "categories": [
            "SIGN_UP"
        ],
        "id": "356169917364619",
        "name": "flow_sign_up",
        "status": "PUBLISHED",
        "validation_errors": []
    }
]
```

--------------------------------

### Sample API Response

Source: https://partner-docs.gupshup.io/reference/gettemplatesfromlibrary_3

Example of a successful response containing a list of templates.

```json
{
    "status": "success",
    "templates": [
        {
            "category": "UTILITY",
            "containerMeta": "sampleData",
            "data": "sampleData",
            "elementName": "account_creation_confirmation_3",
            "industry": "E_COMMERCE,FINANCIAL_SERVICES",
            "languageCode": "nb",
            "topic": "ACCOUNT_UPDATES",
            "usecase": "ACCOUNT_CREATION_CONFIRMATION"
        }
   ]  
}
```

--------------------------------

### Error Response Example

Source: https://partner-docs.gupshup.io/reference/get_partner-app-appid-template-analytics

Example of the JSON response returned when the requested template analytics settings do not exist.

```json
{       "message": "Template Analytics settings for app f3bf7a6b-d694-412e-a5dd-6925c8bb2d15 does not exist",       "status": "error"   }
```

--------------------------------

### Get App Access Token Response

Source: https://partner-docs.gupshup.io/reference/get_partner-app-appid-token

Example JSON response containing the generated or retrieved access token and metadata.

```json
{
    "status": "success",
    "token": {
        "token": "sk_20c901e*********2a592484********1",
        "authoriserId": "aac***e8-d**c-****-a93f-**d6d5a***e8",
        "requestorId": "4**2",
        "createdOn": 1705905891100,
        "modifiedOn": 1705905891100,
        "expiresOn": 0,
        "active": true
    }
}
```

--------------------------------

### Link App Response Example

Source: https://partner-docs.gupshup.io/reference/post_partner-account-api-applink

A successful response returns the details of the linked application.

```json
{
        "partnerApps": {
            "createdOn": 1609829592910,
            "healthy": false,
            "id": "fa*b***e-d2**-****-be38-0****d*9a**b",
            "live": false,
            "modifiedOn": 1614162854108,
            "name": "assistant0092",
            "partnerId": 1,
            "phone": "91**********",
            "stopped": false,
            "walletId": "1**"
        }
    }
```

--------------------------------

### MPM Template Configuration

Source: https://partner-docs.gupshup.io/reference/post_partner-app-appid-template-msg

Example structure for the template parameter when using an MPM template.

```json
template={ "id":"3b9bf65b-979c-44d3-a269-dec2f20c4e52", "params":[ "zqc2qfz5fm" ], "mpm":{ "sections":[{ "title":"Products", "products":[ "zqc2qfz5fm" ] }, { "title":"Products2", "products":[ "xyli96fcbn" ] }] } }
```

--------------------------------

### Get business username response

Source: https://partner-docs.gupshup.io/reference/getbusinessusername

Example of a successful JSON response containing the status and username.

```json
{
  "status": "approved",
  "username": "{{username}}"
}
```

--------------------------------

### POST /partner/app

Source: https://partner-docs.gupshup.io/reference/post_partner-app

Creates a new WABA onboarding application.

```APIDOC
## POST /partner/app

### Description
Use this API to create a new WABA onboarding outside of Gupshup UI.

### Method
POST

### Endpoint
{{partner_portal_base_url}}/partner/app

### Parameters
#### Request Body
- **PARTNER_TOKEN** (string) - Required - JWT Token issued post Partner login.
- **name** (string) - Required - Name for the app (6-150 chars, no special characters).
- **templateMessaging** (boolean) - Optional - Toggle template messaging feature.
- **disableOptinPrefUrl** (boolean) - Optional - Toggle optin preferences.

### Request Example
curl --location --request POST '{{partner_portal_base_url}}/partner/app' \
--header 'token: {{PARTNER_TOKEN}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'name={{appName}}' \
--data-urlencode 'templateMessaging=<true/false>' \
--data-urlencode 'disableOptinPrefUrl=<true/false>'

### Response
#### Success Response (200)
- **appId** (string) - The unique identifier for the created app.

#### Response Example
{
"appId": "<app_id>"
}
```

--------------------------------

### Sample API Response

Source: https://partner-docs.gupshup.io/reference/get_partner-app-appid-discount

Example JSON response containing a list of daily billing and discount details for the requested application.

```json
{
            "dailyAppDiscountList":[
            {
                "appId":"8*****j7-a**3-4**d-8***-c2******7bf**3",
                "cumulativeBill":0,
                "dailyBill":0,
                "day":2,
                "discount":0,
                "gsCap":75,
                "gsFees":0,
                "month":4,
                "partnerId":15,
                "year":2022
            },
            {
                "appId":"8*****j7-a**3-4**d-8***-c2******7bf**3",
                "cumulativeBill":0.014,
                "dailyBill":0.014,
                "day":4,
                "discount":0,
                "gsCap":75,
                "gsFees":0.014,
                "month":4,
                "partnerId":15,
                "year":2022
            }
            ]
        }
```

--------------------------------

### Get Profile Name API Error Responses

Source: https://partner-docs.gupshup.io/reference/getprofilename

Examples of JSON error responses returned by the API for forbidden access or internal server errors.

```json
{
  "message": "Forbidden - no permissions to access resource"
}
```

```json
{
  "status": "error",
  "message": "Internal server error. Please try again later and If Issue still persist than contact Gupshup Dev Support"
}
```

--------------------------------

### Status code response examples

Source: https://partner-docs.gupshup.io/reference/post_partner-app-appid-template-analytics-buttonclick

Examples of JSON responses for successful and unauthorized requests.

```json
{     "stauts": "sucess"   }
```

```json
{       "status": "error",       "message": "Unauthorised access to the resource. Please review request parameters and headers and retry"   }
```

--------------------------------

### POST /partner/app

Source: https://partner-docs.gupshup.io/reference/post_partner-app

Creates a new application from the Partner Portal.

```APIDOC
## POST /partner/app

### Description
Creates a new application from the Partner Portal.

### Method
POST

### Endpoint
https://partner.gupshup.io/partner/app

### Parameters
#### Header Parameters
- **token** (string) - Required - The partner authentication token.

#### Request Body
- **name** (string) - Optional - The name of the application.
- **templateMessaging** (boolean) - Optional - Enable template messaging.
- **disableOptinPrefUrl** (boolean) - Optional - Disable opt-in preference URL.

### Response
#### Success Response (200)
- Successful response

#### Error Responses
- **400** - Bad request
- **401** - Unauthorized
- **500** - Internal server error
```

--------------------------------

### Template Insights API Response Examples

Source: https://partner-docs.gupshup.io/reference/gettemplateinsights

Examples of successful and error responses returned by the insights endpoint.

```json
{
{
    "status": "success",
    "template_insights": [
        {
            "date_start": "2024-11-15",
            "date_stop": "2025-02-12",
            "marketing_messages_cost_per_delivered": "0.153",
            "marketing_messages_cost_per_link_btn_click": "9.18",
            "marketing_messages_delivered": "60",
            "marketing_messages_delivery_rate": "100",
            "marketing_messages_link_btn_click": "1",
            "marketing_messages_link_btn_click_rate": "1.666667",
            "marketing_messages_read": "22",
            "marketing_messages_read_rate": "36.666667",
            "marketing_messages_sent": "60",
            "marketing_messages_spend": "9.18"
        }
    ]
}
}
```

```json
{

"status": "error","message": "MM lite is not enabled for this app"
}
```

```json
{

"status":"error","message":"Invalid template id provided."
}
```

```json
{

"status":"error","message":"Unauthorised access to the resource. Please review request parameters and headers and retry"
}
```

--------------------------------

### Error Response Example

Source: https://partner-docs.gupshup.io/reference/getflowjson

Example of a 400 error response returned when an invalid flow ID is provided.

```json
{
          
            "status": "error",
            "message": "Unsupported get request. Object with ID '52635765283582' does not exist, cannot be loaded due to missing permissions, or does not support this operation. Please read the Graph API documentation at https://developers.facebook.com/docs/graph-api"
        }
```

--------------------------------

### Subscription Schema and Example

Source: https://partner-docs.gupshup.io/reference/get_partner-app-appid-subscription

Defines the structure of a subscription object including metadata, modes, and webhook URL.

```json
"FLOWS_MESSAGE"
                            ]
                          },
                          "modifiedOn": {
                            "type": "integer",
                            "format": "int64",
                            "example": "1735818105594"
                          },
                          "showOnUI": {
                            "type": "boolean"
                          },
                          "tag": {
                            "type": "string",
                            "example": "mm"
                          },
                          "url": {
                            "type": "string",
                            "example": "https://webhook.site/e1d58c71-2c14-4e82-90ce-4fd4c0caaf96"
                          },
                          "version": {
                            "type": "integer",
                            "format": "int32",
                            "example": "3"
                          }
                        }
                      },
                      "example": [
                        {
                          "active": true,
                          "appId": "57d9179b-7412-4621-bf86-57ee1962fd12",
                          "createdOn": 1735818105594,
                          "id": "29040",
                          "mode": 16383,
                          "modes": [
                            "SENT",
                            "DELIVERED",
                            "READ",
                            "DELETED",
                            "OTHERS",
                            "FAILED",
                            "MESSAGE",
                            "TEMPLATE",
                            "ACCOUNT",
                            "BILLING",
                            "ENQUEUED",
                            "FLOWS_MESSAGE",
                            "PAYMENTS",
                            "ALL"
                          ],
                          "modifiedOn": 1735818105594,
                          "showOnUI": false,
                          "tag": "mm",
                          "url": "https://webhook.site/e1d58c71-2c14-4e82-90ce-4fd4c0caaf96",
                          "version": 3
                        }
                      ]
                    }
```

--------------------------------

### WABA Health Status Examples

Source: https://partner-docs.gupshup.io/reference/getwabahealth

JSON examples representing healthy and blocked WhatsApp Business Account states.

```json
{
  "status": "success",
  "wabaInfo": {
    "accountStatus": "ACTIVE",
    "dockerStatus": "CONNECTED",
    "messagingLimit": "TIER_2K",
    "mmLiteStatus": "ELIGIBLE",
    "ownershipType": "CLIENT_OWNED",
    "phone": "918375031069",
    "phoneQuality": "GREEN",
    "wabaId": "216141188246170",
    "canSendMessage": "AVAILABLE",
    "additionalInfo": [],
    "errors": []
  }
}
```

```json
{
  "status": "success",
  "wabaInfo": {
    "accountStatus": "ACTIVE",
    "dockerStatus": "PENDING",
    "messagingLimit": null,
    "mmLiteStatus": "INELIGIBLE",
    "ownershipType": "ON_BEHALF_OF",
    "phone": "918657864833",
    "phoneQuality": "UNKNOWN",
    "wabaId": "101256882767341",
    "canSendMessage": "BLOCKED",
    "additionalInfo": [],
    "errors": [
      {
        "error_code": "141001",
        "error_description": "The phone number you are trying to send messages with is not verified."
```

--------------------------------

### GET /partner/app/{appId}/mmlite/link

Source: https://partner-docs.gupshup.io/reference/getmmlitelink

Retrieves the MM Lite onboarding link for a specified application. Requires a valid partner app token in the header.

```APIDOC
## GET /partner/app/{appId}/mmlite/link

### Description
Get MM Lite link on-boarding for live app.

### Method
GET

### Endpoint
/partner/app/{appId}/mmlite/link

### Parameters
#### Path Parameters
- **appId** (string) - Required - The unique identifier of the application.

#### Header Parameters
- **token** (string) - Required - Your app token.

#### Query Parameters
- **lang** (string) - Optional - Language code for the response.

### Response
#### Success Response (200)
- **link** (string) - The generated MM Lite onboarding link.
- **status** (string) - The status of the request.

#### Error Response (401, 403, 404, 500)
- **status** (integer) - Status Code
- **message** (string) - Error message describing the reason
- **details** (string) - Developer specific error details
- **code** (string) - Internal Error Code
```

--------------------------------

### POST /partner/app/{appId}/templates

Source: https://partner-docs.gupshup.io/reference/post_partner-app-appid-templates-video

Creates a new video template for the specified application.

```APIDOC
## POST /partner/app/{appId}/templates

### Description
Creates a new video template for a specific application using the provided template details and media handle.

### Method
POST

### Endpoint
/partner/app/{appId}/templates

### Parameters
#### Path Parameters
- **appId** (String) - Required - The Id should be a valid app Id of Gupshup. The App must be associated with the account that owns the PARTNER_APP_TOKEN being used.

#### Request Headers
- **Authorization** (String) - Required - Access Token for the application.

#### Request Body
- **elementName** (String) - Required - The name of a template. The element name is unique for a WABAs namespace (max 180 chars).
- **languageCode** (String) - Optional - Language code for the template (default: en_US).
- **content** (String) - Required - The body of the template (max 1024 chars).
- **category** (String) - Required - The category of your template.
- **vertical** (String) - Required - The vertical (max 180 chars).
- **footer** (String) - Optional - Footer of the template.
- **templateType** (String) - Required - Must be set to VIDEO.
- **example** (String) - Required - Template Example.
- **exampleMedia** (String) - Required - Handle Id required to generate media templates.
- **enableSample** (Boolean) - Optional - Required for creating all types of templates.
- **allowTemplateCategoryChange** (Boolean) - Optional - If True, Meta will automatically update the category of the template as per the template content (default: False).
```

--------------------------------

### API Status Code Examples

Source: https://partner-docs.gupshup.io/reference/post_partner-app-appid-obotoembed-whitelist

Example JSON responses for various HTTP status codes returned by the API.

```json
{ "embedSignupUrl": "https://gs.tc.im/kZviNa8Zlx9", "id": "1016427996774921", "status": "success" }
```

```json
{ "message": "Error while whitelisting WABA.", "status": "error" }
```

```json
{ "status": "error", "message": "Too Many Requests" }
```

```json
{ "status": "error", "message": "Internal Server Error" }
```

--------------------------------

### POST /partner/app/{appId}/templates

Source: https://partner-docs.gupshup.io/reference/post_partner-app-appid-templates-video

Creates a new video template for the specified application.

```APIDOC
## POST /partner/app/{appId}/templates

### Description
Creates a new video template for the specified application.

### Method
POST

### Endpoint
https://partner.gupshup.io/partner/app/{appId}/templates

### Parameters
#### Path Parameters
- **appId** (string) - Required - The unique identifier of the application.

#### Request Body
- **elementName** (string) - Required - Name of the template element.
- **languageCode** (string) - Required - Language code for the template.
- **footer** (string) - Optional - Footer text for the template.
- **content** (string) - Required - The main content of the template.
- **category** (string) - Required - The category of the template (e.g., MARKETING).
- **templateType** (string) - Required - The type of template (e.g., VIDEO).
- **vertical** (string) - Optional - The vertical associated with the template.
- **example** (string) - Optional - Example text for the template.
- **enableSample** (boolean) - Optional - Whether to enable sample data.
- **exampleMedia** (string) - Optional - Media data for the template sample.
- **allowTemplateCategoryChange** (boolean) - Optional - Whether to allow changes to the template category.

### Request Example
curl --request POST \
     --url https://partner.gupshup.io/partner/app/{{APP_ID}}/templates \
     --header 'accept: application/json' \
     --header 'content-type: application/x-www-form-urlencoded' \
     --header 'Authorization: sk_711916ad1d5d4f21a9520fdef20516a1' \
     --data elementName=video_element1 \
     --data languageCode=en \
     --data 'footer=This is the footer' \
     --data 'content=Hi {{1}}.' \
     --data category=MARKETING \
     --data templateType=VIDEO \
     --data 'vertical=Ticket updated' \
     --data 'example=Hi User.' \
     --data enableSample=true \
     --data exampleMedia=4::aW1hZ2UvcadG5n:ARYaMMMA2QvIXuQZdPjWVXTOqfoBU3n0L1Ftyg4w57yxi9nD105yQDvW2nu3-HNo9HGefxZ-Ig-HAi3YSsckwIsOEUwxSPatsxT0Niob30E63A:e:1634884682:2281283925530161:100033655335566:ARaBAxW-1L-ZRu6SMSg \
     --data allowTemplateCategoryChange=true

### Response
#### Success Response (200)
- **status** (string) - The status of the request.
- **template** (object) - The created template object.

#### Response Example
{
    "status": "success",
    "template": {
        "appId": "a41b30f4-d202-4fdb-911e-3a8fbfbfb797",
        "category": "MARKETING",
        "containerMeta": "{\"appId\":\"a41b30f4-d202-4fdb-911e-3a8fbfbfb797\",\"data\":\"Hi {{1}}.\",\"footer\":\"This is the footer\",\"sampleText\":\"Hi User.\",\"sampleMedia\":\"4::aW1hZ2UvcadG5n:ARYaMMMA2QvIXuQZdPjWVXTOqfoBU3n0L1Ftyg4w57yxi9nD105yQDvW2nu3-HNo9HGefxZ-Ig-HAi3YSsckwIsOEUwxSPatsxT0Niob30E63A:e:1634884682:2281283925530161:100033655335566:ARaBAxW-1L-ZRu6SMSg\",\"enableSample\":true,\"editTemplate\":false,\"allowTemplateCategoryChange\":true,\"addSecurityRecommendation\":false}",
        "createdOn": 1716282572440,
        "data": "Hi {{1}}.\nThis is the footer",
        "elementName": "video_element1",
        "id": "80206293-ef61-4922-88c0-ff68768f02d8",
        "languageCode": "en",
        "languagePolicy": "deterministic",
        "meta": "{\"example\":\"Hi User.\"}",
        "modifiedOn": 1716282572440,
        "namespace": "9c7fe92f_2a48_40ec_83d0_69c62a772433",
        "priority": 1,
        "quality": "UNKNOWN",
        "retry": 0,
        "stage": "NONE",
        "status": "PENDING",
        "templateType": "VIDEO",
        "vertical": "Ticket updated",
        "wabaId": "104505526065633"
    }
}
```

--------------------------------

### POST /partner/app/{appId}/templates

Source: https://partner-docs.gupshup.io/reference/post_partner-app-appid-templates-video

Creates a new video template for the specified application.

```APIDOC
## POST /partner/app/{appId}/templates

### Description
Creates a new video template for the specified application.

### Method
POST

### Endpoint
https://partner.gupshup.io/partner/app/{appId}/templates

### Parameters
#### Path Parameters
- **appId** (string) - Required - The unique identifier of the application.

### Response
#### Success Response (200)
- **status** (string) - The status of the request.
- **template** (object) - The created template object.

#### Response Example
{
  "status": "success",
  "template": {
    "appId": "a41b30f4-d202-4fdb-911e-3a8fbfbfb797",
    "category": "MARKETING",
    "createdOn": "1716282572440",
    "data": "Hi {{1}}.This is the footer",
    "elementName": "video_element1",
    "id": "80206293-ef61-4922-88c0-ff68768f02d8",
    "languageCode": "en",
    "languagePolicy": "deterministic",
    "modifiedOn": "1716282572440",
    "namespace": "9c7fe92f_2a48_40ec_83d0_69c62a772433",
    "priority": "1",
    "quality": "UNKNOWN",
    "retry": "0",
    "stage": "NONE",
    "status": "PENDING",
    "templateType": "VIDEO",
    "vertical": "Ticket updated",
    "wabaId": "104505526065633"
  }
}
```

--------------------------------

### OpenAPI Specification for Get Templates

Source: https://partner-docs.gupshup.io/reference/get_partner-app-appid-templates

The OpenAPI definition for the Get Templates endpoint, detailing the request parameters and response structure.

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Get Templates 1",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://partner.gupshup.io/"
    }
  ],
  "paths": {
    "/partner/app/{appId}/templates": {
      "get": {
        "tags": [
          "default"
        ],
        "summary": "Get Templates",
        "parameters": [
          {
            "name": "token",
            "in": "header",
            "schema": {
              "type": "string"
            },
            "required": true,
            "description": "Your app token, please refer [**Get access token api**](https://partner-docs.gupshup.io/reference/get_partner-app-appid-token) to get the token from partner documentation.",
            "example": "sk_61b3021c97214370b341f8baaae0xxxx"
          },
          {
            "name": "appId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true,
            "description": "Unique identifier of the app.",
            "example": "9e97650d-xxxx-xxxx-xxxx-4cdf47c3fa68"
          },
          {
            "name": "templateType",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "required": false,
            "description": "Filter templates by template type (e.g., TEXT, CAROUSEL, etc.)."
          },
          {
            "name": "useable",
            "in": "query",
            "schema": {
              "type": "boolean"
            },
            "required": false,
            "description": "Filter templates by usable flag."
          },
          {
            "name": "stages",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "required": false,
            "description": "List of stages to filter by, separated by commas."
          },
          {
            "name": "elementName",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "required": false,
            "description": "Filter templates by element name."
          },
          {
            "name": "startTime",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int64"
            },
            "required": false,
            "description": "Start time filter (epoch millis)."
          },
          {
            "name": "endTime",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int64"
            },
            "required": false,
            "description": "End time filter (epoch millis)."
          },
          {
            "name": "status",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "required": false,
            "description": "Filter templates by status (e.g., PENDING,APPROVED, REJECTED, SUBMITTED, DEACTIVATED, etc.)."
          },
          {
            "name": "data",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "required": false,
            "description": "Filter templates by data/content."
          },
          {
            "name": "pageNo",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "required": false,
            "description": "Page number for pagination."
          },
          {
            "name": "pageSize",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "required": false,
            "description": "Page size for pagination."
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "success"
                    },
                    "templates": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "appId": {
                            "type": "string",
                            "example": "bf9ee64c-3d4d-4ac4-8668-732e577007c4"
                          },
                          "category": {
                            "type": "string",
                            "example": "UTILITY"
                          },
                          "containerMeta": {
                            "type": "string",
                            "example": null
                          },
                          "createdOn": {

```

--------------------------------

### API Request Parameters

Source: https://partner-docs.gupshup.io/reference/post_partner-app-appid-templates-carouselimage

Examples for the required authentication token and application identifier path parameter.

```text
sk_61b3021c97214370b341f8baaae0xxxx
```

```text
9e97650d-xxxx-xxxx-xxxx-4cdf47c3fa68
```

--------------------------------

### Bearer Authentication Header Example

Source: https://partner-docs.gupshup.io/reference/deletebusinessusername

Example of the Authorization header format required for API requests using a JWT bearer token.

```http
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
```

--------------------------------

### Postback Text Configuration

Source: https://partner-docs.gupshup.io/reference/post_partner-app-appid-template-msg

JSON array format for defining postback text for quick reply buttons.

```json
[     {       "index": 3, // button index starts from 0       "text": "hello" //postback text for the button     }   ]
```

```json
[{"index":4,"text":"hello"},{"index":5,"text":"hey"}]
```

--------------------------------

### Enable Explorer and Proxy Configuration

Source: https://partner-docs.gupshup.io/reference/post_partner-app-appid-templates-location

Use this JSON snippet to toggle the explorer and proxy settings to true within your configuration file.

```json
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```

--------------------------------

### OpenAPI Specification for Get Templates from Library

Source: https://partner-docs.gupshup.io/reference/gettemplatesfromlibrary_3

Defines the GET endpoint for retrieving templates from the library, including required parameters and response schemas.

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Partner Portal API",
    "description": "Partner Portal API documentation",
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.gupshup.io"
    },
    "version": "3.0.0-SNAPSHOT"
  },
  "externalDocs": {
    "description": "Gupshup Wiki Documentation",
    "url": "https://www.gupshup.io/partner/docs"
  },
  "servers": [
    {
      "url": "https://partner.gupshup.io/partner",
      "description": "Generated server url"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Partner's Linked Application",
      "description": "API's for partners linked applications"
    }
  ],
  "paths": {
    "/app/{appId}/template/metalibrary": {
      "get": {
        "tags": [
          "Partner's Linked Application"
        ],
        "summary": "Get templates from library",
        "operationId": "getTemplatesFromLibrary_3",
        "parameters": [
          {
            "name": "appId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "requestParams",
            "in": "query",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/MultiValueMapStringString"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetTemplatesLibrary"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden - no permissions to access resource",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ErrorResponse": {
        "required": [
          "entity",
          "status"
        ],
        "type": "object",
        "properties": {
          "status": {
            "type": "integer",
            "description": "Status Code",
            "format": "int32"
          },
          "message": {
            "type": "string",
            "description": "Error message describing the reason "
          },
          "details": {
            "type": "string",
            "description": "Developer specific error details "
          },
          "code": {
            "type": "string",
            "description": "Internal Error Code",
            "default": "PP-ERR-XXX"
          },
          "entity": {
            "type": "object",
            "description": "Response Object"
          }
        },
        "description": "Error"
      },
      "MultiValueMapStringString": {
        "type": "object",
        "properties": {
          "all": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "writeOnly": true
          },
          "empty": {
            "type": "boolean"
          }
        },
        "additionalProperties": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "GetTemplatesLibrary": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string"
          },
          "templates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Template"
            }
          }
        }
      },
      "Template": {
        "type": "object",
        "properties": {
          "category": {
            "type": "string"
          },
          "containerMeta": {
            "type": "string"
          },
          "data": {
            "type": "string"
          },
          "elementName": {
            "type": "string"
          }
        }
      }
    }
  }
}
```
Tokens:
Raw