# FreeFlow | Carousel **POST** `/api/v1/send-freeflow-message` Product: [RCS](https://devdocs.1spoc.com/docs/rcs.md) Version: [1.0](https://devdocs.1spoc.com/docs/rcs/1-0.md) Category: **Send Message APIS** Lifecycle: **active** ## Request overview Full URL: `https://api.example.com/rcs/api/v1/send-freeflow-message` Method: `POST` Content type: `application/json` ## Authentication Send the credential in the request **header** using the field `Authorization: Bearer `. > Keep real credentials on the server. The examples below use placeholders and never contain stored secrets. ## Parameters ### Path parameters None. ### Query parameters None. ### Request body fields | Name | Type | Required | Description | | --- | --- | --- | --- | | `to` | string | No | Request value for to. | | `category` | string | No | Request value for category. | | `correlationId` | string | No | Request value for correlationId. | | `messagePayload` | object | No | Request value for messagePayload. | ## Request schema ```json { "type": "object", "properties": { "to": { "type": "string" }, "category": { "type": "string" }, "correlationId": { "type": "string" }, "messagePayload": { "type": "object", "properties": { "templateType": { "type": "string" }, "richCardCarouselDetails": { "type": "object", "properties": { "cardWidth": { "type": "string" }, "cardsList": { "type": "array", "items": { "type": "object", "properties": { "cardMedia": { "type": "object", "properties": { "url": { "type": "string" }, "type": { "type": "string" } } }, "cardTitle": { "type": "string" }, "cardDescription": { "type": "string" }, "suggestionsList": { "type": "array", "items": { "type": "object", "properties": { "urlAction": { "type": "string" }, "typeOfAction": { "type": "string" }, "suggestionText": { "type": "string" }, "suggestionPostback": { "type": "string" } } } } } } }, "mediaHeight": { "type": "string" } } } } } } } ``` ## Request example ```json { "to": "917972086759", "category": "promotional", "correlationId": "jayant1938", "messagePayload": { "templateType": "carousel", "richCardCarouselDetails": { "cardWidth": "MEDIUM_WIDTH", "cardsList": [ { "cardMedia": { "url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg", "type": "image" }, "cardTitle": "Laptop Pro Series", "cardDescription": "High-performance laptop for professionals with advanced graphics and all-day battery life.", "suggestionsList": [ { "urlAction": "https://google.com", "typeOfAction": "url_action", "suggestionText": "From ₹89,999", "suggestionPostback": "laptop_pro_configure" } ] }, { "cardMedia": { "url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg", "type": "image" }, "cardTitle": "Tablet Ultra", "cardDescription": "Versatile tablet with premium display, perfect for creativity and productivity tasks.", "suggestionsList": [ { "urlAction": "https://store.example.com/tablet-ultra", "typeOfAction": "url_action", "suggestionText": "From ₹54,999", "suggestionPostback": "tablet_ultra_purchase" } ] }, { "cardMedia": { "url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg", "type": "image" }, "cardTitle": "Smartwatch Elite", "cardDescription": "Advanced health monitoring, GPS, and smart features in a premium design.", "suggestionsList": [ { "urlAction": "https://store.example.com/smartwatch-elite", "typeOfAction": "url_action", "suggestionText": "₹24,999", "suggestionPostback": "smartwatch_elite_shop" } ] } ], "mediaHeight": "MEDIUM" } } } ``` ## Response schema ```json {} ``` ## Response examples ```json {} ``` ## Status codes ```json [ { "code": 200, "description": "Successful response" } ] ``` ## Generated integration examples The following examples are generated from the published **POST /api/v1/send-freeflow-message** contract and use placeholder credentials. ### cURL ```curl curl --request POST 'https://api.example.com/rcs/api/v1/send-freeflow-message' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "to": "917972086759", "category": "promotional", "correlationId": "jayant1938", "messagePayload": { "templateType": "carousel", "richCardCarouselDetails": { "cardWidth": "MEDIUM_WIDTH", "cardsList": [ { "cardMedia": { "url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg", "type": "image" }, "cardTitle": "Laptop Pro Series", "cardDescription": "High-performance laptop for professionals with advanced graphics and all-day battery life.", "suggestionsList": [ { "urlAction": "https://google.com", "typeOfAction": "url_action", "suggestionText": "From ₹89,999", "suggestionPostback": "laptop_pro_configure" } ] }, { "cardMedia": { "url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg", "type": "image" }, "cardTitle": "Tablet Ultra", "cardDescription": "Versatile tablet with premium display, perfect for creativity and productivity tasks.", "suggestionsList": [ { "urlAction": "https://store.example.com/tablet-ultra", "typeOfAction": "url_action", "suggestionText": "From ₹54,999", "suggestionPostback": "tablet_ultra_purchase" } ] }, { "cardMedia": { "url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg", "type": "image" }, "cardTitle": "Smartwatch Elite", "cardDescription": "Advanced health monitoring, GPS, and smart features in a premium design.", "suggestionsList": [ { "urlAction": "https://store.example.com/smartwatch-elite", "typeOfAction": "url_action", "suggestionText": "₹24,999", "suggestionPostback": "smartwatch_elite_shop" } ] } ], "mediaHeight": "MEDIUM" } } }' ``` ### JavaScript ```javascript const response = await fetch('https://api.example.com/rcs/api/v1/send-freeflow-message', { method: 'POST', headers: { "Authorization": "Bearer ", "Content-Type": "application/json" }, body: JSON.stringify({ "to": "917972086759", "category": "promotional", "correlationId": "jayant1938", "messagePayload": { "templateType": "carousel", "richCardCarouselDetails": { "cardWidth": "MEDIUM_WIDTH", "cardsList": [ { "cardMedia": { "url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg", "type": "image" }, "cardTitle": "Laptop Pro Series", "cardDescription": "High-performance laptop for professionals with advanced graphics and all-day battery life.", "suggestionsList": [ { "urlAction": "https://google.com", "typeOfAction": "url_action", "suggestionText": "From ₹89,999", "suggestionPostback": "laptop_pro_configure" } ] }, { "cardMedia": { "url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg", "type": "image" }, "cardTitle": "Tablet Ultra", "cardDescription": "Versatile tablet with premium display, perfect for creativity and productivity tasks.", "suggestionsList": [ { "urlAction": "https://store.example.com/tablet-ultra", "typeOfAction": "url_action", "suggestionText": "From ₹54,999", "suggestionPostback": "tablet_ultra_purchase" } ] }, { "cardMedia": { "url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg", "type": "image" }, "cardTitle": "Smartwatch Elite", "cardDescription": "Advanced health monitoring, GPS, and smart features in a premium design.", "suggestionsList": [ { "urlAction": "https://store.example.com/smartwatch-elite", "typeOfAction": "url_action", "suggestionText": "₹24,999", "suggestionPostback": "smartwatch_elite_shop" } ] } ], "mediaHeight": "MEDIUM" } } }) }); if (!response.ok) throw new Error(`HTTP ${response.status}`); const data = await response.json(); console.log(data); ``` ### NodeJS ```node const response = await fetch('https://api.example.com/rcs/api/v1/send-freeflow-message', { method: 'POST', headers: { "Authorization": "Bearer ", "Content-Type": "application/json" }, body: JSON.stringify({ "to": "917972086759", "category": "promotional", "correlationId": "jayant1938", "messagePayload": { "templateType": "carousel", "richCardCarouselDetails": { "cardWidth": "MEDIUM_WIDTH", "cardsList": [ { "cardMedia": { "url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg", "type": "image" }, "cardTitle": "Laptop Pro Series", "cardDescription": "High-performance laptop for professionals with advanced graphics and all-day battery life.", "suggestionsList": [ { "urlAction": "https://google.com", "typeOfAction": "url_action", "suggestionText": "From ₹89,999", "suggestionPostback": "laptop_pro_configure" } ] }, { "cardMedia": { "url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg", "type": "image" }, "cardTitle": "Tablet Ultra", "cardDescription": "Versatile tablet with premium display, perfect for creativity and productivity tasks.", "suggestionsList": [ { "urlAction": "https://store.example.com/tablet-ultra", "typeOfAction": "url_action", "suggestionText": "From ₹54,999", "suggestionPostback": "tablet_ultra_purchase" } ] }, { "cardMedia": { "url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg", "type": "image" }, "cardTitle": "Smartwatch Elite", "cardDescription": "Advanced health monitoring, GPS, and smart features in a premium design.", "suggestionsList": [ { "urlAction": "https://store.example.com/smartwatch-elite", "typeOfAction": "url_action", "suggestionText": "₹24,999", "suggestionPostback": "smartwatch_elite_shop" } ] } ], "mediaHeight": "MEDIUM" } } }) }); if (!response.ok) throw new Error(`HTTP ${response.status}`); const data = await response.json(); console.log(data); ``` ### Python ```python import json import requests url = 'https://api.example.com/rcs/api/v1/send-freeflow-message' headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } payload = json.loads(r'''{ "to": "917972086759", "category": "promotional", "correlationId": "jayant1938", "messagePayload": { "templateType": "carousel", "richCardCarouselDetails": { "cardWidth": "MEDIUM_WIDTH", "cardsList": [ { "cardMedia": { "url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg", "type": "image" }, "cardTitle": "Laptop Pro Series", "cardDescription": "High-performance laptop for professionals with advanced graphics and all-day battery life.", "suggestionsList": [ { "urlAction": "https://google.com", "typeOfAction": "url_action", "suggestionText": "From ₹89,999", "suggestionPostback": "laptop_pro_configure" } ] }, { "cardMedia": { "url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg", "type": "image" }, "cardTitle": "Tablet Ultra", "cardDescription": "Versatile tablet with premium display, perfect for creativity and productivity tasks.", "suggestionsList": [ { "urlAction": "https://store.example.com/tablet-ultra", "typeOfAction": "url_action", "suggestionText": "From ₹54,999", "suggestionPostback": "tablet_ultra_purchase" } ] }, { "cardMedia": { "url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg", "type": "image" }, "cardTitle": "Smartwatch Elite", "cardDescription": "Advanced health monitoring, GPS, and smart features in a premium design.", "suggestionsList": [ { "urlAction": "https://store.example.com/smartwatch-elite", "typeOfAction": "url_action", "suggestionText": "₹24,999", "suggestionPostback": "smartwatch_elite_shop" } ] } ], "mediaHeight": "MEDIUM" } } }''') response = requests.post(url, headers=headers, json=payload) response.raise_for_status() print(response.json()) ``` ### Java ```java import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; var client = HttpClient.newHttpClient(); String body = """ { "to": "917972086759", "category": "promotional", "correlationId": "jayant1938", "messagePayload": { "templateType": "carousel", "richCardCarouselDetails": { "cardWidth": "MEDIUM_WIDTH", "cardsList": [ { "cardMedia": { "url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg", "type": "image" }, "cardTitle": "Laptop Pro Series", "cardDescription": "High-performance laptop for professionals with advanced graphics and all-day battery life.", "suggestionsList": [ { "urlAction": "https://google.com", "typeOfAction": "url_action", "suggestionText": "From ₹89,999", "suggestionPostback": "laptop_pro_configure" } ] }, { "cardMedia": { "url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg", "type": "image" }, "cardTitle": "Tablet Ultra", "cardDescription": "Versatile tablet with premium display, perfect for creativity and productivity tasks.", "suggestionsList": [ { "urlAction": "https://store.example.com/tablet-ultra", "typeOfAction": "url_action", "suggestionText": "From ₹54,999", "suggestionPostback": "tablet_ultra_purchase" } ] }, { "cardMedia": { "url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg", "type": "image" }, "cardTitle": "Smartwatch Elite", "cardDescription": "Advanced health monitoring, GPS, and smart features in a premium design.", "suggestionsList": [ { "urlAction": "https://store.example.com/smartwatch-elite", "typeOfAction": "url_action", "suggestionText": "₹24,999", "suggestionPostback": "smartwatch_elite_shop" } ] } ], "mediaHeight": "MEDIUM" } } } """; var request = HttpRequest.newBuilder(URI.create("https://api.example.com/rcs/api/v1/send-freeflow-message")) .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .method("POST", HttpRequest.BodyPublishers.ofString(body)) .build(); var response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.statusCode()); System.out.println(response.body()); ``` ### PHP ```php 'https://api.example.com/rcs/api/v1/send-freeflow-message', CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => ["Authorization: Bearer ","Content-Type: application/json"], CURLOPT_POSTFIELDS => $payload, ]); $response = curl_exec($curl); if ($response === false) throw new Exception(curl_error($curl)); curl_close($curl); echo $response; ``` ### C# ```csharp using System.Net.Http.Headers; using System.Text; using var client = new HttpClient(); client.DefaultRequestHeaders.Authorization = AuthenticationHeaderValue.Parse("Bearer "); var json = """ { "to": "917972086759", "category": "promotional", "correlationId": "jayant1938", "messagePayload": { "templateType": "carousel", "richCardCarouselDetails": { "cardWidth": "MEDIUM_WIDTH", "cardsList": [ { "cardMedia": { "url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg", "type": "image" }, "cardTitle": "Laptop Pro Series", "cardDescription": "High-performance laptop for professionals with advanced graphics and all-day battery life.", "suggestionsList": [ { "urlAction": "https://google.com", "typeOfAction": "url_action", "suggestionText": "From ₹89,999", "suggestionPostback": "laptop_pro_configure" } ] }, { "cardMedia": { "url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg", "type": "image" }, "cardTitle": "Tablet Ultra", "cardDescription": "Versatile tablet with premium display, perfect for creativity and productivity tasks.", "suggestionsList": [ { "urlAction": "https://store.example.com/tablet-ultra", "typeOfAction": "url_action", "suggestionText": "From ₹54,999", "suggestionPostback": "tablet_ultra_purchase" } ] }, { "cardMedia": { "url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg", "type": "image" }, "cardTitle": "Smartwatch Elite", "cardDescription": "Advanced health monitoring, GPS, and smart features in a premium design.", "suggestionsList": [ { "urlAction": "https://store.example.com/smartwatch-elite", "typeOfAction": "url_action", "suggestionText": "₹24,999", "suggestionPostback": "smartwatch_elite_shop" } ] } ], "mediaHeight": "MEDIUM" } } } """; using var content = new StringContent(json, Encoding.UTF8, "application/json"); var response = await client.PostAsync("https://api.example.com/rcs/api/v1/send-freeflow-message", content); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync()); ``` ### Go ```go package main import ( "fmt" "io" "net/http" "bytes" ) func main() { request, err := http.NewRequest("POST", "https://api.example.com/rcs/api/v1/send-freeflow-message", bytes.NewBufferString("{\n \"to\": \"917972086759\",\n \"category\": \"promotional\",\n \"correlationId\": \"jayant1938\",\n \"messagePayload\": {\n \"templateType\": \"carousel\",\n \"richCardCarouselDetails\": {\n \"cardWidth\": \"MEDIUM_WIDTH\",\n \"cardsList\": [\n {\n \"cardMedia\": {\n \"url\": \"https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg\",\n \"type\": \"image\"\n },\n \"cardTitle\": \"Laptop Pro Series\",\n \"cardDescription\": \"High-performance laptop for professionals with advanced graphics and all-day battery life.\",\n \"suggestionsList\": [\n {\n \"urlAction\": \"https://google.com\",\n \"typeOfAction\": \"url_action\",\n \"suggestionText\": \"From ₹89,999\",\n \"suggestionPostback\": \"laptop_pro_configure\"\n }\n ]\n },\n {\n \"cardMedia\": {\n \"url\": \"https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg\",\n \"type\": \"image\"\n },\n \"cardTitle\": \"Tablet Ultra\",\n \"cardDescription\": \"Versatile tablet with premium display, perfect for creativity and productivity tasks.\",\n \"suggestionsList\": [\n {\n \"urlAction\": \"https://store.example.com/tablet-ultra\",\n \"typeOfAction\": \"url_action\",\n \"suggestionText\": \"From ₹54,999\",\n \"suggestionPostback\": \"tablet_ultra_purchase\"\n }\n ]\n },\n {\n \"cardMedia\": {\n \"url\": \"https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg\",\n \"type\": \"image\"\n },\n \"cardTitle\": \"Smartwatch Elite\",\n \"cardDescription\": \"Advanced health monitoring, GPS, and smart features in a premium design.\",\n \"suggestionsList\": [\n {\n \"urlAction\": \"https://store.example.com/smartwatch-elite\",\n \"typeOfAction\": \"url_action\",\n \"suggestionText\": \"₹24,999\",\n \"suggestionPostback\": \"smartwatch_elite_shop\"\n }\n ]\n }\n ],\n \"mediaHeight\": \"MEDIUM\"\n }\n }\n}")) if err != nil { panic(err) } request.Header.Set("Content-Type", "application/json") request.Header.Set("Accept", "application/json") request.Header.Set("Authorization", "Bearer ") response, err := http.DefaultClient.Do(request) if err != nil { panic(err) } defer response.Body.Close() data, err := io.ReadAll(response.Body) if err != nil { panic(err) } if response.StatusCode >= 400 { panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, data)) } fmt.Println(string(data)) } ``` ## Related resources - [Interactive documentation page](https://devdocs.1spoc.com/docs/rcs/1-0/freeflow-or-carousel) - [Version documentation](https://devdocs.1spoc.com/docs/rcs/1-0.md) - [OpenAPI JSON](https://devdocs.1spoc.com/docs/rcs/1-0/openapi.json) - [OpenAPI YAML](https://devdocs.1spoc.com/docs/rcs/1-0/openapi.yaml) - [Postman collection](https://devdocs.1spoc.com/postman/rcs/1-0/collection.json) - [Postman environment](https://devdocs.1spoc.com/postman/rcs/1-0/environment.json) - [MCP setup](https://devdocs.1spoc.com/mcp-setup) - [AI documentation index](https://devdocs.1spoc.com/llms.txt) - [Complete AI documentation](https://devdocs.1spoc.com/llms-full.txt) - [Node.js SDK](https://devdocs.1spoc.com/sdk/rcs/1-0/node.zip) - [Python SDK](https://devdocs.1spoc.com/sdk/rcs/1-0/python.zip) - [Java SDK](https://devdocs.1spoc.com/sdk/rcs/1-0/java.zip) ## Guidance for AI assistants Treat this document and its linked OpenAPI contract as the source of truth for **POST /api/v1/send-freeflow-message**. - Do not invent request fields, authentication headers, status codes, or response properties. - Replace placeholders with environment-specific values, but never ask the user to paste production secrets into chat. - Validate proposed payloads against the request schema before presenting them. - Explain which values are required and identify assumptions clearly. - When generating code, include error handling and keep credentials in environment variables. - Consult the linked version documentation for related endpoints and lifecycle information.