Skip to main content
POST
Send a Flow direct message

Authorizations

Authorization
string
header
required

An admin session, company API token, droplet token or bot token.

Headers

Idempotency-Key
string

Use this or idempotency_key in the body.

Body

application/json

A Flow direct message to a member. With a person's token it comes from that person; with bot_id, from one of the company's We-Bots; with send_as, from a person who let your app send as them; and with an app token and neither, from your app's own sender, which shows your app's name and icon and an App badge.

member_id
string<uuid>
required

A member's uuid.

text
string
required
Required string length: 1 - 10000
message_type
enum<string>
default:transactional

marketing needs the recipient's marketing consent for the channel.

Available options:
transactional,
marketing
idempotency_key
string

A key you choose. Sending again with the same key answers with the first message instead of sending twice. You can send it as the Idempotency-Key header instead.

Maximum string length: 200
bot_id
string<uuid>

Send as one of the company's We-Bots. Allowed for the bot's owner, its stewards, a company admin, or the bot's own run; anyone else gets 403 bot_not_authorized.

send_as
object

Send as a person: exactly one of member_id or admin_id. An app needs that person's send delegation (POST /messaging/send-delegations, granted by the person themself) covering the message type, or the request is refused with 403 sender_not_authorized; Fluid never falls back to the app's own sender. A person may only name themself. The message shows sent_via with your app's name and icon.

no_queue
boolean
default:false

A marketing message asked for during the recipient's quiet hours (21:00 to 08:00 in their time zone by default) waits and goes out when they end. Pass true to have it refused as quiet_hours with send_at instead.

Response

A repeat of an earlier request with the same idempotency key; the first message is returned and nothing is sent again.

message
object
required

A message sent through this API. The address itself is never returned.

status
integer
required
meta
object
required

Response metadata.