Outreach

Read campaigns and the shared inbox, and send a message.

Campaigns on WhatsApp, text and email, plus one shared inbox for the replies. Everything sends from the number and address that belong to the workspace, never ours.

List campaigns

bash

curl https://app.softsolz.uk/api/v1/services/outreach/campaigns \
  -H "Authorization: Bearer sk_live_your_key"

Read the shared inbox

bash

curl https://app.softsolz.uk/api/v1/services/outreach/inbox/conversations \
  -H "Authorization: Bearer sk_live_your_key"

Consent is enforced for you

A contact who has opted out of a channel is skipped, and that applies across the whole platform rather than just Outreach. You do not need to filter opt-outs yourself, and you cannot override them through the API.

Record consent

Post to /consents with a channel of sms, whatsapp, email or ai_call, the address, a status of opted_in or opted_out, and the wording the person agreed to. Marketing calls from an AI caller only reach people with ai_call consent; agreeing to texts or email does not count.

bash

curl https://app.softsolz.uk/api/v1/services/outreach/consents \
  -H "Authorization: Bearer sk_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{"channel":"ai_call","address":"+447700900123","status":"opted_in","wording":"You can call me with offers, including by an AI assistant."}'

React to replies and calls

Subscribe to outreach.message_received to be told when somebody answers, and outreach.campaign_completed when a send finishes.

outreach.call.completed fires when any call ends. handled_by is team for a call your team placed and ai for a call an AI caller answered or made. AI calls also carry ai_caller, direction, a short summary and follow_up_needed, so you can pass follow-ups to your own system.

Every endpoint in the API Reference, and the walkthrough on docs.softsolz.uk.