> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zixflow.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Send Template Message

# Send RCS Template Message

This API enables you to send RCS template messages to users who have a live session. Only approved templates are supported for message sending.

### Request Body Parameters

<ParamField body="to" type="string" required placeholder="Enter phone number">
  Specifies the recipient's phone number in international format (e.g.,
  "1xxxxxxxxxx").
</ParamField>

<ParamField body="botId" type="string" required placeholder="Enter bot ID">
  This is the unique identifier associated with the RCS bot. Find the BOT ID on
  the Zixflow RCS Settings page. [RCS
  Settings](https://app.zixflow.com/campaign/settings/rcs)
</ParamField>

<ParamField body="templateName" type="string" required placeholder="Enter Template Name">
  The name of the approved template for sending RCS messages.
</ParamField>

<ParamField body="variables" type="object" placeholder="Enter Variables">
  (Optional) An object with key-value pairs to populate template placeholders.
</ParamField>

<ParamField body="source" type="string" placeholder="Enter Source Type" initialValue="API" default="API">
  If the "linkWithRecord" is set to true, the source from which the WhatsApp
  message is sent should be mentioned; otherwise, it defaults to API.
</ParamField>

<ParamField body="linkWithRecord" type="boolean" placeholder="Enter true or false">
  Specify whether to associate the current message with a record and display it
  in the inbox. Set it to "true" for linking with a record; otherwise, it
  defaults to "false."
</ParamField>

<ParamField body="reportURL" type="string" placeholder="Enter report URL">
  (Optional) Specify the URL where the user's report and deliveries should be
  delivered.
</ParamField>

<ParamField body="submissionStatus" type="boolean" placeholder="Enter true or false">
  (Optional) Indicates whether to wait for the submission status. Set it to
  "true" if you want to wait for the submission status; otherwise, it defaults
  to "false."
</ParamField>

### Response

<ResponseField name="status" type="boolean">
  Indicates if the API call was successful. Returns true if successful, false
  otherwise.
</ResponseField>

<ResponseField name="message" type="string">
  Provides a message indicating success or details of any error.
</ResponseField>

### Response Examples

<ResponseExample>
  ```json 200-Success theme={null}
  {
    "status": true,
    "message": "Message sent successfully"
  }
  ```

  ```json 400-Bad Request theme={null}
  {
    "status": false,
    "message": "Invalid data Provided"
  }
  ```

  ```json 401-Unauthorised theme={null}
  {
    "status": false,
    "message": "Unauthorised"
  }
  ```
</ResponseExample>