> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://apidocs.me-mate.net/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://apidocs.me-mate.net/_mcp/server. # Send Flow Service Message POST https://business.me-mate.net/sendservicemessages/sendmessages#postSendservicemessagesSendmessages9 Content-Type: application/json This endpoint allows you to send service messages to individual recipients via the WhatsApp messaging product. ### Request - Method: POST - URL: `https://business.me-mate.net/sendservicemessages/sendmessages` - Headers: - Content-Type: application/json - Body: - `to` (string): The recipient's number. - `type` (string): in this case, "interactive". - `interactive` (object): The interactive message content. - `body` (object): The body of the interactive message. - `text` (string): The text content of the message body. - `type` (string): The type of interactive message, in this case it must be, "flow". - `action` (object): The action to be performed with the interactive message. - `name` (string): The name of the action, in this case, "flow". - `parameters` (object): Parameters for the action. - `flow_id` (string): Unique ID of the Flow provided by WhatsApp. - `flow_cta` (string): The display name for the flow button. - `flow_token` (string): Token to identify the corresponding flow. Flow token that is generated by the business to serve as an identifier. - `flow_action` (string): The action to be performed, like: `navigate` or `data_exchange`.**(Default value:** **`navigate`**). - `flow_action_payload` (object): Payload for the action. `screen name` and `data` which is optional. `flow_action_payload is`required if `flow_action` is `navigate`. - `flow_message_version` (string): The version of the flow message it must be 3. - `footer` (object): The footer of the interactive message. - `text` (string, optional): The text content of the message footer. - `header` (object): The header of the interactive message. - `text` (string): The text content of the message header. - `type` (string): The type of header, in this case, "text". **Note : You can use Different Types of message Header (like: Image, video and Document) same as Reply Button** - `recipient_type` (string): The type of recipient, in this case, "individual". - `messaging_product` (string): The messaging product, in this case, "whatsapp". - `api_key` (string): Your production API key. > [How to get Your API key?](#requirements) ### Response The response for this request is a JSON schema with the following structure: - messaging_product (string): The messaging product used. - contacts (array): An array of contacts with the following details: - input (string): The input details. - wa_id (string): The WhatsApp ID. - messages (array): An array of messages with the following details: - id (string): The ID of the message (by Meta). Reference: https://apidocs.me-mate.net/business-me-mate-net-ap-is-document-v-1-0/send-service-message-ap-is/for-production-production-env/send-flow-service-message ## Request ### Body (application/json) - `to` (string, required) - `type` (string, required) - `api_key` (string, required) - `interactive` (object, required) - `body` (object, required) - `text` (string, required) - `type` (string, required) - `action` (object, required) - `name` (string, required) - `parameters` (object, required) - `flow_id` (string, required) - `flow_cta` (string, required) - `flow_token` (string, required) - `flow_action` (string, required) - `flow_action_payload` (object, required) - `screen` (string, required) - `flow_message_version` (string, required) - `footer` (object, required) - `text` (string, required) - `header` (object, required) - `text` (string, required) - `type` (string, required) - `recipient_type` (string, required) - `messaging_product` (string, required) ## Response ### 200 OK - `contacts` (list of object, required) - `input` (string, required) - `wa_id` (string, required) - `messages` (list of object, required) - `id` (string, required) - `messaging_product` (string, required) ## Examples **Request** ```json { "to": "recipient-number", "type": "interactive", "api_key": "Your-production-Api-Key", "interactive": { "body": { "text": "write body text here" }, "type": "flow", "action": { "name": "flow", "parameters": { "flow_id": "Unique ID of the Flow provided by WhatsApp", "flow_cta": "flow Button display name", "flow_token": "token to identify the corresponding Flow (e.g. 7f451b5d-38e2-40c7-b70d-6984ffc19fc4)", "flow_action": "navigate", "flow_action_payload": { "screen": "screenA" }, "flow_message_version": "3" } }, "footer": { "text": "write footer text here" }, "header": { "text": "write header text here", "type": "text" } }, "recipient_type": "individual", "messaging_product": "whatsapp" } ``` **Response** ```json { "contacts": [ { "input": "recipient's-number", "wa_id": "recipient's-number" } ], "messages": [ { "id": "wamid.HBgMOTE3MzE5OTUwMzUwFQIAERgSREMyQkZFQUVEMzdGRUY2MEEzAA==" } ], "messaging_product": "whatsapp" } ``` **SDK Code** ```python import requests url = "https://business.me-mate.net/sendservicemessages/sendmessages#postSendservicemessagesSendmessages9" payload = { "to": "recipient-number", "type": "interactive", "api_key": "Your-production-Api-Key", "interactive": { "body": { "text": "write body text here" }, "type": "flow", "action": { "name": "flow", "parameters": { "flow_id": "Unique ID of the Flow provided by WhatsApp", "flow_cta": "flow Button display name", "flow_token": "token to identify the corresponding Flow (e.g. 7f451b5d-38e2-40c7-b70d-6984ffc19fc4)", "flow_action": "navigate", "flow_action_payload": { "screen": "screenA" }, "flow_message_version": "3" } }, "footer": { "text": "write footer text here" }, "header": { "text": "write header text here", "type": "text" } }, "recipient_type": "individual", "messaging_product": "whatsapp" } headers = {"Content-Type": "application/json"} response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://business.me-mate.net/sendservicemessages/sendmessages#postSendservicemessagesSendmessages9'; const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"to":"recipient-number","type":"interactive","api_key":"Your-production-Api-Key","interactive":{"body":{"text":"write body text here"},"type":"flow","action":{"name":"flow","parameters":{"flow_id":"Unique ID of the Flow provided by WhatsApp","flow_cta":"flow Button display name","flow_token":"token to identify the corresponding Flow (e.g. 7f451b5d-38e2-40c7-b70d-6984ffc19fc4)","flow_action":"navigate","flow_action_payload":{"screen":"screenA"},"flow_message_version":"3"}},"footer":{"text":"write footer text here"},"header":{"text":"write header text here","type":"text"}},"recipient_type":"individual","messaging_product":"whatsapp"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://business.me-mate.net/sendservicemessages/sendmessages#postSendservicemessagesSendmessages9" payload := strings.NewReader("{\n \"to\": \"recipient-number\",\n \"type\": \"interactive\",\n \"api_key\": \"Your-production-Api-Key\",\n \"interactive\": {\n \"body\": {\n \"text\": \"write body text here\"\n },\n \"type\": \"flow\",\n \"action\": {\n \"name\": \"flow\",\n \"parameters\": {\n \"flow_id\": \"Unique ID of the Flow provided by WhatsApp\",\n \"flow_cta\": \"flow Button display name\",\n \"flow_token\": \"token to identify the corresponding Flow (e.g. 7f451b5d-38e2-40c7-b70d-6984ffc19fc4)\",\n \"flow_action\": \"navigate\",\n \"flow_action_payload\": {\n \"screen\": \"screenA\"\n },\n \"flow_message_version\": \"3\"\n }\n },\n \"footer\": {\n \"text\": \"write footer text here\"\n },\n \"header\": {\n \"text\": \"write header text here\",\n \"type\": \"text\"\n }\n },\n \"recipient_type\": \"individual\",\n \"messaging_product\": \"whatsapp\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://business.me-mate.net/sendservicemessages/sendmessages#postSendservicemessagesSendmessages9") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Content-Type"] = 'application/json' request.body = "{\n \"to\": \"recipient-number\",\n \"type\": \"interactive\",\n \"api_key\": \"Your-production-Api-Key\",\n \"interactive\": {\n \"body\": {\n \"text\": \"write body text here\"\n },\n \"type\": \"flow\",\n \"action\": {\n \"name\": \"flow\",\n \"parameters\": {\n \"flow_id\": \"Unique ID of the Flow provided by WhatsApp\",\n \"flow_cta\": \"flow Button display name\",\n \"flow_token\": \"token to identify the corresponding Flow (e.g. 7f451b5d-38e2-40c7-b70d-6984ffc19fc4)\",\n \"flow_action\": \"navigate\",\n \"flow_action_payload\": {\n \"screen\": \"screenA\"\n },\n \"flow_message_version\": \"3\"\n }\n },\n \"footer\": {\n \"text\": \"write footer text here\"\n },\n \"header\": {\n \"text\": \"write header text here\",\n \"type\": \"text\"\n }\n },\n \"recipient_type\": \"individual\",\n \"messaging_product\": \"whatsapp\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://business.me-mate.net/sendservicemessages/sendmessages#postSendservicemessagesSendmessages9") .header("Content-Type", "application/json") .body("{\n \"to\": \"recipient-number\",\n \"type\": \"interactive\",\n \"api_key\": \"Your-production-Api-Key\",\n \"interactive\": {\n \"body\": {\n \"text\": \"write body text here\"\n },\n \"type\": \"flow\",\n \"action\": {\n \"name\": \"flow\",\n \"parameters\": {\n \"flow_id\": \"Unique ID of the Flow provided by WhatsApp\",\n \"flow_cta\": \"flow Button display name\",\n \"flow_token\": \"token to identify the corresponding Flow (e.g. 7f451b5d-38e2-40c7-b70d-6984ffc19fc4)\",\n \"flow_action\": \"navigate\",\n \"flow_action_payload\": {\n \"screen\": \"screenA\"\n },\n \"flow_message_version\": \"3\"\n }\n },\n \"footer\": {\n \"text\": \"write footer text here\"\n },\n \"header\": {\n \"text\": \"write header text here\",\n \"type\": \"text\"\n }\n },\n \"recipient_type\": \"individual\",\n \"messaging_product\": \"whatsapp\"\n}") .asString(); ``` ```php request('POST', 'https://business.me-mate.net/sendservicemessages/sendmessages#postSendservicemessagesSendmessages9', [ 'body' => '{ "to": "recipient-number", "type": "interactive", "api_key": "Your-production-Api-Key", "interactive": { "body": { "text": "write body text here" }, "type": "flow", "action": { "name": "flow", "parameters": { "flow_id": "Unique ID of the Flow provided by WhatsApp", "flow_cta": "flow Button display name", "flow_token": "token to identify the corresponding Flow (e.g. 7f451b5d-38e2-40c7-b70d-6984ffc19fc4)", "flow_action": "navigate", "flow_action_payload": { "screen": "screenA" }, "flow_message_version": "3" } }, "footer": { "text": "write footer text here" }, "header": { "text": "write header text here", "type": "text" } }, "recipient_type": "individual", "messaging_product": "whatsapp" }', 'headers' => [ 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://business.me-mate.net/sendservicemessages/sendmessages#postSendservicemessagesSendmessages9"); var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"to\": \"recipient-number\",\n \"type\": \"interactive\",\n \"api_key\": \"Your-production-Api-Key\",\n \"interactive\": {\n \"body\": {\n \"text\": \"write body text here\"\n },\n \"type\": \"flow\",\n \"action\": {\n \"name\": \"flow\",\n \"parameters\": {\n \"flow_id\": \"Unique ID of the Flow provided by WhatsApp\",\n \"flow_cta\": \"flow Button display name\",\n \"flow_token\": \"token to identify the corresponding Flow (e.g. 7f451b5d-38e2-40c7-b70d-6984ffc19fc4)\",\n \"flow_action\": \"navigate\",\n \"flow_action_payload\": {\n \"screen\": \"screenA\"\n },\n \"flow_message_version\": \"3\"\n }\n },\n \"footer\": {\n \"text\": \"write footer text here\"\n },\n \"header\": {\n \"text\": \"write header text here\",\n \"type\": \"text\"\n }\n },\n \"recipient_type\": \"individual\",\n \"messaging_product\": \"whatsapp\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Content-Type": "application/json"] let parameters = [ "to": "recipient-number", "type": "interactive", "api_key": "Your-production-Api-Key", "interactive": [ "body": ["text": "write body text here"], "type": "flow", "action": [ "name": "flow", "parameters": [ "flow_id": "Unique ID of the Flow provided by WhatsApp", "flow_cta": "flow Button display name", "flow_token": "token to identify the corresponding Flow (e.g. 7f451b5d-38e2-40c7-b70d-6984ffc19fc4)", "flow_action": "navigate", "flow_action_payload": ["screen": "screenA"], "flow_message_version": "3" ] ], "footer": ["text": "write footer text here"], "header": [ "text": "write header text here", "type": "text" ] ], "recipient_type": "individual", "messaging_product": "whatsapp" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://business.me-mate.net/sendservicemessages/sendmessages#postSendservicemessagesSendmessages9")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```