> ## 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.

# Trigger Sendflow

> Trigger a Sendflow automation workflow

#### Description

This endpoint allows you to trigger a Sendflow automation workflow. You can pass recipient information (phone and email) and custom variables to the workflow, and optionally run it in draft mode for testing.

#### Headers

<ParamField header="x-api-key" type="string" required placeholder="Enter your API key">
  Your API key for authentication.
</ParamField>

<ParamField header="x-workspace-id" type="string" required placeholder="Enter your workspace ID">
  Your workspace ID for authentication.
</ParamField>

#### Path Parameters

<ParamField path="sendflow_id" type="string" required placeholder="Enter Sendflow ID">
  The unique identifier of the Sendflow workflow to trigger.
</ParamField>

#### Query Parameters

<ParamField query="is_draft" type="boolean" placeholder="Enter true or false">
  Whether to run the workflow in draft mode. Default: false. Use true for testing workflows.
</ParamField>

#### Body

<ParamField body="recipients" type="object" required placeholder="Enter recipients">
  Recipient information for the workflow. Contains fixed phone and email fields.

  <Expandable title="recipients" defaultOpen="true">
    <ParamField body="phone" type="string" placeholder="Enter phone number">
      The phone number of the recipient in international format (e.g., "919876543210").
    </ParamField>

    <ParamField body="email" type="string" placeholder="Enter email address">
      The email address of the recipient.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="variables" type="object" placeholder="Enter variables">
  Key-value pairs for template variables. Keys should match the variable names in your Sendflow workflow, and values will replace the placeholders.
</ParamField>

#### Request Example

```json theme={null}
{
  "recipients": {
    "phone": "919876543210",
    "email": "demo@example.com"
  },
  "variables": {
    "name": "sam"
  }
}
```

#### Response

<ResponseField name="success" type="boolean">
  Indicates whether the call was successful. true if successful, false if not.
</ResponseField>

<ResponseField name="message" type="string">
  Success or error response message.
</ResponseField>

<ResponseField name="request_id" type="string">
  The unique identifier for this workflow execution request. Use this ID to stop the workflow if needed.
</ResponseField>

<ResponseExample>
  ```json 200-Success theme={null}
  {
    "success": true,
    "message": "Sendflow triggered successfully",
    "request_id": "req_1234567890"
  }
  ```

  ```json 400-Bad Request theme={null}
  {
    "success": false,
    "message": "Invalid sendflow_id"
  }
  ```
</ResponseExample>