Send Whatsapp Template Message For A Phone Number

POST

https://api.chakrahq.com/v1/ext/plugin/whatsapp/{pluginId}/phoneNumber/{phoneNumber}/send-template-message

This API allows you to send a whatsapp template message for a given phone number

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/json

Example

{
	"whatsappPhoneNumberId": "775966265503012",
	"templateName": "christmas_promo_23",
	"mapping": [
		{
			"schemaPropertyName": "1",
			"schemaPropertyValue": "John"
		}
	],
  "imageUrl": "https://chakra-public-media.chakrahq.com/5fc9f8e3-af4a-4f29-bfd8-6c02e3abe3ee/2024-10-17/9b755981-74f7-4cde-b495-cd7039991964.png"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.chakrahq.com/v1/ext/plugin/whatsapp/d83e1d23-50b8-4d87-8f92-842a0ac516f6/phoneNumber/913399113344/send-template-message' \
--header 'Content-Type: application/json' \
--data-raw '{
	"whatsappPhoneNumberId": "775966265503012",
	"templateName": "christmas_promo_23",
	"mapping": [
		{
			"schemaPropertyName": "1",
			"schemaPropertyValue": "John"
		}
	],
  "imageUrl": "https://chakra-public-media.chakrahq.com/5fc9f8e3-af4a-4f29-bfd8-6c02e3abe3ee/2024-10-17/9b755981-74f7-4cde-b495-cd7039991964.png"
}'

Responses

🟢200Success

application/json

Body

Example

{
	"_data": {
		"id": "359e676b-624f-45e9-833d-e109ae414557",
		"createdAt": 1729231290842,
		"updatedAt": 1729231290842,
		"externalId": "wamid.HBgMOTE5OTAxMjU4NDMzFQIAERgSRjE4OEZFM0UyOTc1ODMyOUZEAA==",
		"provider": "WHATSAPP",
		"dataType": "text",
		"body": {
			"body": "Hi John,\nThis christmas decorate make your loved ones happier with Chakra Wellness products. Visit our website to know more!\n❄🎄"
		},
		"text": "Hi John,\nThis christmas decorate make your loved ones happier with Chakra Wellness products. Visit our website to know more!\n❄🎄",
		"attachments": null,
		"deliveryStatus": "SENT",
		"direction": "OUTBOUND",
		"timestamp": 1729231290387,
		"context": {
			"contactIdentifier": "919901258433",
			"messageTemplateId": "e296d971-305c-4009-a9b6-2cb7fd1ee3cf"
		},
		"adhocAgent": null,
		"source": {
			"sourceId": "send-template-message-for-process",
			"sourceType": "API"
		},
		"team": "5fc9f8e3-af4a-4f29-bfd8-6c02e3abe3ee",
		"chat": null,
		"plugin": "d83e1d23-50b8-4d87-8f92-842a0ac516f6",
		"contact": null,
		"user": "5bc39b1d-5aa7-48a3-9436-51c103a18a3b",
		"procedure": null,
		"process": "b656bf3b-4248-47f9-b145-c64452ae2b00",
		"campaign": null,
		"inReplyTo": null
	}
}

Modified at 2025-07-14 11:30:37

Send Whatsapp Template Message For Process

Upload Public Media