Messaging API

Base URL: https://app.servflo.ai/api. Every call needs Authorization: Bearer sfk_… (Authentication); {organizationId} ($ORGANIZATION_ID in the examples) is your business's id.

Get messaging settings

Quiet hours (in the organization's timezone; default 21:00–08:00), the cap on automated messages per customer per day, sender name, reply-to, business phone and review link. Read-only.

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/messaging/settings" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

Change messaging settings

Quiet hours, the daily cap per customer, sender name, reply-to, business phone and review link. Only the fields sent change.

Request body

Example

curl -X PATCH "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/messaging/settings" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"quietHoursEnabled":true,"quietHoursStart":"09:00","quietHoursEnd":"09:00"}'

Response

List the email and SMS providers

The provider of each channel: test mode (log only, the default) or the connected provider with its sender, the last four characters of its credential, its webhook URLs (inbound texts, delivery status, bounces) and the last test. Never returns credentials. Read-only.

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/messaging/channels" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

Connect an email or SMS provider

Sends data out: sets the channel's provider: test (log only), or resend / postmark / sendgrid / mailgun / ses (EMAIL) or twilio (SMS) with its sender and credentials. Credentials are encrypted at rest and never returned; leave a credential blank to keep the stored one. From then on messages really go out through it.

Parameters

Request body

Example

curl -X PATCH "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/messaging/channels/{channel}" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"providerKey":"test"}'

Response

Disconnect a provider (back to test mode)

Destructive: deletes the channel's provider and its stored credentials; messages are logged in test mode (SENT_TEST) again and nothing is sent.

Parameters

Example

curl -X DELETE "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/messaging/channels/{channel}" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

Send a test message

Sends a message: a short test email or text to the given address through the channel's provider (in test mode it is only logged, SENT_TEST). The outcome is recorded on the provider and in the message log.

Parameters

Request body

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/messaging/channels/{channel}/test" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to":"2026-11-03"}'

Response

Simulate a customer's text reply (test mode)

Test mode only (no SMS provider connected): processes a text as if the customer sent it from from, exactly like a signed Twilio webhook: STOP / START / HELP change consent, the reply is logged as an inbound message and message.replied ends cadences. 400 with a real provider (replies come from its webhook).

Request body

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/messaging/simulate-reply" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"2026-11-03","body":"string"}'

Response

Simulate a customer's email (test mode)

Test mode only (ServFlo email not live): processes an email as if the customer sent it, exactly like one received through SES: to the reply address of inReplyToMessageId (one of this business's emails), else to the business's ServFlo address. It lands in the Inbox matched to the customer, tells the staff and forwards a copy. 400 when ServFlo email is live.

Request body

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/messaging/simulate-email" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"dana@example.com","body":"string"}'

Response

Run the automations now

Customer-facing: runs this organization's engine once without waiting for the worker: arms and fires due RELATIVE timers (reminders), runs due scheduled rules, advances cadences and sends due messages. The outbox (events) is consumed for every organization in order, as the worker does. now is for tests only (refused in production).

Request body

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/messaging/run" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"now":"2026-11-03T15:00:00Z"}'

Response