Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.

Body

application/json

One outbound text. Every field is required and whitespace-trimmed before validation. Unlike initiateEscalation there is no agent or destination to name: the conversation is keyed by the from number's assigned agent, so the recipient's reply lands on the same thread.

from
string
required

The sending number in E.164. Must be a number this workspace owns that is SMS-enabled (smsStatus: active) and assigned to an agent.

Example:

"+14155550100"

to
string
required

The recipient in E.164. Must be a US or Canada (+1) number, different from from and not one of this workspace's own numbers, with a recorded consent basis (conversational or express).

Example:

"+14155551234"

text
string
required

The message. Send the message ONLY — on a first contact the platform prefixes your brand name and appends the "Msg & data rates may apply. Reply HELP for help, STOP to opt out." block. The text is converted to plain ASCII: smart punctuation is mapped to its plain equivalent; accented letters, emoji and other non-ASCII characters are removed. A message that is empty after that conversion is refused (400). The result is capped at two segments (truncating at a sentence boundary).

Maximum string length: 4000
Example:

"Hi Dana — your cleaning is confirmed for Tue 9am."

client_message_id
string
required

Idempotency key naming this one message (at most 200 characters; a UUID is ideal). A replay returns the original receipt and never sends a second text; reusing it for a different message is 409 client_message_id_reused.

Maximum string length: 200
Example:

"6f1c2d3e-4a5b-6789-abcd-ef0123456789"

Response

The text was sent (also returned, byte for byte, on an idempotent replay of the same client_message_id).

success
boolean
required
data
object
required

The receipt for a sent text.

message
string
errors
object[]