Rate Limit

10 Requests per Minute

Sample Request

curl --location 'https://partner.gupshup.io/partner/app/:appId/template/metalibrary?elementName=&industry=&languageCode=&topic=&usecase=' \
--header 'Authorization : {{PARTNER_APP_TOKEN}}'

Sample Response

{
    "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"
        }
   ]  
}

Request Parameters

Key	Description	Constraints
Headers
PARTNER_APP_TOKEN	App Access Token issued post partner login	Should be a valid partner app access token belonging to the passed appId
Query Params
elementName	Name of element	Meta library template name - Optional
industry	Name of industry	Possible values E_COMMERCE, FINANCIAL_SERVICES - Optional
languageCode	Language code of the meta library template	Optional
topic	Topic of the meta library template	Possible values ACCOUNT_UPDATES, CUSTOMER_FEEDBACK, ORDER_MANAGEMENT, PAYMENTS - Optional
usecase	Use case of the meta library template	Possible values ACCOUNT_CREATION_CONFIRMATION, AUTO_PAY_REMINDER, DELIVERY_CONFIRMATION, DELIVERY_FAILED, DELIVERY_UPDATE, FEEDBACK_SURVEY, FIXED_TEMPLATE_PRICE_TEST, FRAUD_ALERT, LOW_BALANCE_WARNING, ORDER_ACTION_NEEDED, ORDER_CONFIRMATION, ORDER_DELAY, ORDER_OR_TRANSACTION_CANCEL, ORDER_PICK_UP, PAYMENT_ACTION_REQUIRED, PAYMENT_CONFIRMATION, PAYMENT_DUE_REMINDER, PAYMENT_NOTICE, PAYMENT_OVERDUE, PAYMENT_REJECT_FAIL, PAYMENT_SCHEDULED, RECEIPT_ATTACHMENT, RETURN_CONFIRMATION, SHIPMENT_CONFIRMATION, STATEMENT_ATTACHMENT, STATEMENT_AVAILABLE, TRANSACTION_ALERT - Optional
Path Params
appId	App Id for the app that is linked to the Partner Account

Status Codes

Status Code	Response	Comments
Success
200	{ "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" },	If templates are found for the given filter(s)
200	{ "status": "success", "templates": [] }	If no templates are found for the given filter(s)
Error
401	{ "message": "Authentication Failed", "status": "error" }
429	{ "status": "error", "message": "Too Many Requests" }	10 Requests per Minute
500	{ "status": "error", "message": "Internal Server Error" }	For any Internal Error

200Success

401Unauthorized

403Forbidden - no permissions to access resource

404Not Found

500Internal Server Error