> ## Documentation Index > Fetch the complete documentation index at: https://developer.rocket.chat/llms.txt > Use this file to discover all available pages before exploring further. # Send a WhatsApp Template Message > Use this endpoint to send WhatsApp template messages directly to specified contacts from your workspace. 1. Click the **Marketplace** icon from the main menu. Select **Explore** from the drop-down menu. 2. Locate your preferred WhatsApp App. 3. Go to *App Info > Details > APIs* and find the `POST templateMessage` section. 4. Copy the `POST templateMessage` endpoint URL for your WhatsApp app from the provided curl example. This URL includes the required `appId`. Send a template message request using this URL as the endpoint. Before sending template messages from Rocket.Chat through any WhatsApp App, ensure that you have set up the templates in respective WhatsApp provider account. Refer to the official guide for details on configuring template messages for each WhatsApp app. ## OpenAPI ````json POST /api/apps/public/{appId}/templateMessage { "openapi": "3.0.0", "info": { "version": "1.0.0", "title": "Miscellaneous" }, "servers": [ { "url": "https://apiexplorer.support.rocket.chat" } ], "paths": { "/api/apps/public/{appId}/templateMessage": { "post": { "tags": [ "WhatsApp" ], "summary": "Send a WhatsApp Template Message", "description": "Use this endpoint to send WhatsApp template messages directly to specified contacts from your workspace.\n\n1. Click the **Marketplace** icon from the main menu. Select **Explore** from the drop-down menu.\n2. Locate your preferred WhatsApp App.\n3. Go to *App Info > Details > APIs* and find the `POST templateMessage` section.\n4. Copy the `POST templateMessage` endpoint URL for your WhatsApp app from the provided curl example. This URL includes the required `appId`. Send a template message request using this URL as the endpoint.\n\nBefore sending template messages from Rocket.Chat through any WhatsApp App, ensure that you have set up the templates in respective WhatsApp provider account. Refer to the official guide for details on configuring template messages for each WhatsApp app.", "operationId": "post-api-apps-public-app_id-templateMessage", "parameters": [ { "name": "appId", "in": "path", "required": "true", "schema": { "type": "string" } } ], "requestBody": { "description": "We strongly recommend including the + prefix for all phone numbers in the payload. While you can submit numbers without the leading + sign, we have encountered cases where WhatsApp will return an invalid response despite the number being in use.", "content": { "application/json": { "schema": { "type": "object", "properties": { "phoneNumbers": { "type": "array", "description": "Recipient WhatsApp IDs where you want to send the template message. You can validate a WhatsApp id from here.", "items": { "type": "string" } }, "connectedWhatsAppNo": { "type": "string", "description": "The WhatsApp Number from which you want to send this template message. The WhatsApp number connected to your workspace via the app." }, "targetAgent": { "type": "string", "description": "Username of the agent you want to transfer the chat to when the WhatsApp user replies." }, "targetDepartment": { "type": "string", "description": "Department name or ID where you want to transfer the chat to when the WhatsApp user replies." }, "template": { "type": "object", "description": "Provide the details of the template message you want to send. The structure of the template object may differ depending on the template defined within your WhatsApp provider account. For further clarification, refer to the official guide on sending template messages via API in Rocket.Chat. The example template object provided here is based on the configuration outlined in the official guide for the WhatsApp Cloud App.\n\nIf your template message includes parameters, make sure to replace all of them with the appropriate information before sending. Failure to do so may lead to an error.", "properties": { "namespace": { "type": "string" }, "name": { "type": "string" }, "language": { "type": "object", "properties": { "code": { "type": "string" }, "policy": { "type": "string" } } }, "components": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "text": { "type": "string" } } } } } } } } } }, "required": [ "phoneNumbers", "connectedWhatsAppNo", "template" ] }, "examples": { "WhatsApp Cloud": { "value": { "phoneNumbers": [ "2368106035555" ], "connectedWhatsAppNo": "104920685899299", "template": { "name": "ship", "language": { "code": "en", "policy": "deterministic" }, "components": [ { "type": "body", "parameters": [ { "type": "text", "text": "20" } ] } ] } } }, "WhatsApp 360Dialog (Cloud API)": { "value": { "phoneNumbers": [ "xxxxxxxxxxxxx" ], "connectedWhatsAppNo": "555195251xxx", "template": { "name": "boarding_pass", "language": { "code": "en", "policy": "deterministic" }, "components": [ { "type": "header", "parameters": [ { "type": "text", "text": "halo" } ] }, { "type": "body", "parameters": [ { "type": "text", "text": "abc" }, { "type": "text", "text": "xyz" } ] } ] } } }, "Whatsapp Sandbox": { "value": { "phoneNumbers": [ "50364357612" ], "template": { "name": "first_welcome_messsage", "language": { "code": "en" }, "components": [ { "type": "body", "parameters": [ { "type": "text", "text": "Your name goes here" } ] } ] } } } } } } }, "responses": { "200": { "$ref": "#/components/responses/trueSuccess" }, "401": { "$ref": "#/components/responses/authorizationError" }, "403": { "$ref": "#/components/responses/forbiddenError" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "string" } } }, "examples": { "Too many phone numbers": { "value": { "success": "false", "error": "Too many phone numbers! Please make sure that phoneNumbers are <= 250" } }, "Agent Not Found": { "value": { "success": "false", "error": "No Agent found with username abc98" } }, "Department Not Found": { "value": { "success": "false", "error": "No Department found with id/Name SalesDepartment" } }, "Invalid WhatsApp Contact": { "value": { "success": "false", "error": "Connected WhatsApp Number (connectedWhatsAppNo) i.e. 565412001234 is not a valid WhatsApp contact. Contact Status is invalid" } }, "Invalid Connected WhatsApp Number": { "value": { "success": "false", "error": "Error! Connected WhatsApp Number (connectedWhatsAppNo) i.e. 565412001234 has not been registered yet on Rocket.Chat. Please goto #omnichannel-whatsapp-setup channel and connect this WhatsApp number first there before sending this request again." } } } } } } } } } }, "components": { "responses": { "trueSuccess": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } }, "examples": { "Success": { "value": { "success": "true" } } } } } }, "authorizationError": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" } } }, "examples": { "Authorization Error": { "value": { "status": "error", "message": "You must be logged in to do this." } } } } } }, "forbiddenError": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "string" } } }, "examples": { "Permission Error": { "value": { "success": "false", "error": "User does not have the permissions required for this action [error-unauthorized]" } } } } } } } } } ````