Send a single message to one person

Sends a real text or WhatsApp message through the connected provider, or an email from the workspace sending address. Answers 409 channel_not_configured (with the reason in details) when no provider or sending number is connected, so nothing was sent, 412 workspace_sender_required when an email is sent before a sending address is set up, and 409 recipient_opted_out when the person replied STOP or unsubscribed. channel must be sms, whatsapp or email; an email also needs a subject.

POSThttps://app.softsolz.uk/api/v1/services/outreach/messages

Recent Requests

Kept only in this browser

TimeStatusTook

Send a request with Try it to see it here.

Headers

Authorizationstringrequired

Bearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Body Params

tostringrequired

Phone number with country code, or an email address when channel is email.

bodystringrequired

Message text.

subjectstring

Subject line. Required when channel is email.

channelstring

Channel to send on (default sms).

customer_idinteger

Booking customer to file the message under.

Response

Response Body

sentbooleanTrue when the message went out.

channelstring | nullChannel used, on email messages.

fromstring | nullSending address, on email messages.

providerstringProvider that carried the message.

providerRefstringThe provider's own reference for the message.

conversationIdinteger | nullInbox conversation.

Request

curl --request POST \
  --url https://app.softsolz.uk/api/v1/services/outreach/messages \
  --header 'Authorization: Bearer sk_live_your_key' \
  --header 'Content-Type: application/json' \
  --data '{
  "to": "+447700900123",
  "body": "Your table is ready.",
  "channel": "sms"
}'

Credentials

Authorization

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 201

{
  "data": {
    "sent": true,
    "channel": null,
    "from": null,
    "provider": "twilio",
    "providerRef": "SM5f1b...",
    "conversationId": 311
  }
}