Skip to main content
POST
Trigger Sendflow

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

string
required
Your API key for authentication.
string
required
Your workspace ID for authentication.

Path Parameters

string
required
The unique identifier of the Sendflow workflow to trigger.

Query Parameters

boolean
Whether to run the workflow in draft mode. Default: false. Use true for testing workflows.

Body

object
required
Recipient information for the workflow. Contains fixed phone and email fields.
object
Key-value pairs for template variables. Keys should match the variable names in your Sendflow workflow, and values will replace the placeholders.

Request Example

Response

boolean
Indicates whether the call was successful. true if successful, false if not.
string
Success or error response message.
string
The unique identifier for this workflow execution request. Use this ID to stop the workflow if needed.