Skip to main content
POST
Send a text 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 text message, sent from the company's registered number.

text
string
required
Required string length: 1 - 1600
to
string

An email address (email) or an E.164 phone number (sms, whatsapp). Use this or one of the ids.

contact_id
string

A contact's id or uuid. Fluid uses the contact's best email or phone for the channel.

customer_id
string

A customer's id, as the customers API returns it. Customers and members are the same people.

member_id
string<uuid>

A member's uuid.

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