Generate Message
Send an AI-generated message through either SMS or email to a specified recipient with optional metadata and dynamic configurations.
Headers
API key used for authenticating requests to the API.
Workspace identifier for the API.
Request Body
Unique identifier for the message flow sending the message. Ensure the Message Flow ID belongs to an active flow.
Recipient’s contact information. Use E.164 format for SMS (e.g., +1234567890
) and a valid email address format for Email (e.g., user@example.com
).
Ensure the contact format matches the messageChannel type: SMS for phone numbers and Email for email addresses. Using an incorrect format or type will result in an error.
Enable automatically sending the generated message to the intended recipient. If your flow has a delay
enabled, the message will be sent after that delay. Defaults to false
.
Dynamic inputs for AI-generated messages.
Response Fields
Indicates (success
) if the request was successful.
Unique identifier for the newly created or fetched existing conversation.
Unique identifier for the newly created message within the conversation.
Content of the message sent. This will always be the corresponding message flow’s initiationMessage
.