---
updatedAt: 2025-10-14T06:25:45.000Z
agentTools:
projectIndex: https://partner-docs.gupshup.io/llms.txt
---
# Edit Template
Use this API to edit a template using *templateId*.
**Note:**Updating carousel templates with Media is not permitted
You will need the below details to start using this API.
1. App Id
2. Template Id
### Parameters
| Key | Description | Required/Optional | Type | Value |
| :------------ | :--------------------------------------------------------------------------------------------------------- | :---------------- | :------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Authorization | Access Token for the application | Required | String | \{\{PARTNER\_APP\_TOKEN}} |
| appId | Unique identifier of the Gupshup app | Required | String | \{\{APP\_ID}} |
| templateId | Unique identifier for a template, refer Get templates api | Required | String | fc05da-f2135-45e2-8sad4-dc44xxxx |
| content | TEXT: The body of the template. Character limit: 1028 | Optional | String | your ticket has been confirmed for \{\{1}} persons on date \{\{2}}. |
| templateType | The type of template: TEXT, IMAGE, VIDEO & DOCUMENT | Optional | String | TEXT |
| example | TEXT - An example of the template. | Optional | String | your ticket has been confirmed for 4 persons on date 2020-05-04 |
| enableSample | BOOLEAN: True or False. Required for creating all types of templates. | Optional | Boolean | true |
| header | Header of the template. Applicable for templateType = Text Character limit: 60 | Optional | String | This is the header |
| footer | Footer of the template. Character limit: 60 | Optional | String | This is the footer |
| buttons | Used only if your template has a CTA. An example is also submitted if a URL button has variable parameter. | Optional | String | [\{"type":"PHONE\_NUMBER","text":"Call Us","phone\_number":"+xxxxxxxxxxx"},\{"type":"URL","text":"Book A Demo","url":"\[https://bookins.gupshup.io/\{\{1}}","example":\["https://bookins.gupshup.io/abc"\]}\]](https://bookins.gupshup.io/\{\{1}}","example":\["https://bookins.gupshup.io/abc"]}]) |
| exampleMedia | Get handleId from [here](https://docs.gupshup.io/reference/post_partner-app-appid-upload-media) | Optional | String | `4::aW1hZ2UvcadG5n:ARYaMMMA2QvIXuQZdPjWVXTOqfoBU3n0L1Ftyg4w57yxi9nD105yQDvW2nu3-HNo9HGefxZ-Ig-HAi3YSsckwIsOEUwxSPatsxT0Niob30E63A:e:1634884682:2281283925530161:100033655335566:ARaBAxW-1L-ZRu6SMSg` |
| mediaId | Media ID | Optional | String | TEXT |
| mediaUrl | Media URL | Optional | String | TEXT |
| category | Use category from these option AUTHENTICATION, MARKETING, UTILITY in description. | Optional | String | AUTHENTICATION |
### Sample Request
```curl
curl --location --request PUT 'https://partner.gupshup.io/partner/app/{{APP_ID}}/templates/{{TEMPLATE_ID}}' \
--header 'Authorization: {{PARTNER_APP_TOKEN}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'content={{CONTENT}}' \
--data-urlencode 'category={{TEMPLATE_CATEGORY}}' \
--data-urlencode 'templateType={{TEMPLATE_TYPE}}' \
--data-urlencode 'example={{EXAMPLE}}' \
--data-urlencode 'exampleMedia={{EXAMPLE_MEDIA}}' \
--data-urlencode 'header={{TEMPLATE_HEADER}}' \
--data-urlencode 'footer={{TEMPLATE_FOOTER}}' \
--data-urlencode 'buttons={{TEMPLATE_BUTTON}}' \
--data-urlencode 'mediaId={{MEDIA_ID}}' \
--data-urlencode 'exampleHeader={{EXAMPLE_HEADER}}'
```
### Sample Response
```json
{
"status": "success"
}
```
### Status Codes
| Status Code | Response | Comments |
| :--------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------- |
| **Success** | | |
| 200 | `{ "id": "460001903531489", "preview": { "expires_at": "2024-09-08T13:45:06+0000", "preview_url": "https://business.facebook.com/wa/manage/flows/460001903531489/preview/?token=a926bc93-ce7f-465e-9c61-60800e9befab" }, "status": "success" }` | |
| **Error** | | |
| 400 | `{ "status":"error", "message":"No Template found for given id" }` | |
| Template does not exist for the provided templateId. | | |
| | | |
# OpenAPI definition
```json
{
"openapi": "3.0.3",
"info": {
"title": "Partner Portal Public APIs",
"version": "1.0.0"
},
"servers": [
{
"url": "https://partner.gupshup.io"
}
],
"tags": [
{
"name": "App"
}
],
"paths": {
"/partner/app/{appId}/templates/{templateId}": {
"put": {
"tags": [
"App"
],
"summary": "App | Edit template",
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"elementName": {
"type": "string",
"example": "ticket_check_url_345456"
},
"languageCode": {
"type": "string",
"example": "en_US"
},
"category": {
"type": "string",
"example": "TICKET_UPDATE"
},
"isMaster": {
"type": "boolean",
"example": "true"
},
"active": {
"type": "boolean",
"example": "true"
},
"status": {
"type": "string",
"example": "APPROVED"
},
"namespace": {
"type": "string",
"example": "4baa9054_9e0b_9569_3dac_6d3b01aa0bbb"
},
"externalId": {
"type": "integer",
"example": "2132"
},
"isGlobal": {
"type": "boolean",
"example": "false"
},
"appId": {
"type": "string",
"example": "9e97650d-add3-4557-9535-4cdf47c3fa68"
},
"vertical": {
"type": "string",
"example": "BUTTON_CHECK"
},
"templateType": {
"type": "string",
"example": "TEXT"
},
"meta": {
"type": "string",
"example": "{\"example\":\"your ticket has been confirmed for {{1}} persons on date {{2}}\"}"
},
"content": {
"type": "string",
"example": "your ticket has been confirmed for {{1}} persons on date {{2}}."
},
"buttons": {
"type": "string",
"example": "[{\"type\":\"PHONE_NUMBER\",\"text\":\"connect here\",\"phone_number\":\"+918286836492\"},{\"type\":\"URL\",\"text\":\"check \",\"url\":\"https://www.speedtest.net/{{1}}\"}]"
}
}
}
}
}
},
"parameters": [
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
},
"example": "{{PARTNER_APP_TOKEN}}"
},
{
"name": "appId",
"in": "path",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "templateId",
"in": "path",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {}
}
}
}
}
}
},
"x-readme": {
"explorer-enabled": true,
"proxy-enabled": true
}
}
```