Messages API

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

List messagesCopy Anchor Link

The message log: every email and text sent (or logged in test mode as SENT_TEST), deferred by quiet hours, skipped with its reason, failed or bounced, and every inbound reply (direction INBOUND). Filter by status, channel, direction, customer, automation, dates or text. Newest first. Read-only.

ParametersCopy Anchor Link

ExampleCopy Anchor Link

curl "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/messages" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY"

ResponseCopy Anchor Link

Get a messageCopy Anchor Link

One message with the exact rendered body (and the email's HTML), its status timeline (queued, deferred, sent, delivered, failed …), what produced it and the replies to it. Read-only.

ParametersCopy Anchor Link

ExampleCopy Anchor Link

curl "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/messages/{messageId}" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY"

ResponseCopy Anchor Link

Preview a manual sendCopy Anchor Link

The Send dialog for a quote, an invoice (or a reminder about it), or a customer's portal link: who it goes to and whether consent allows it, the other addresses to choose from, and the rendered subject and body to edit. Nothing is sent, but the record's customer link (invoice or portal) is made if it does not exist yet. Then POST /messages/send.

Request bodyCopy Anchor Link

ExampleCopy Anchor Link

curl -X POST "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/messages/send/preview" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"quote","recordId":"record_id","channel":"EMAIL"}'

ResponseCopy Anchor Link

Send a message to a customerCopy Anchor Link

Customer-facing: sends the (possibly edited) message from POST /messages/send/preview by email or text, now, or at the end of quiet hours. Sending a draft quote marks it sent; sending a draft invoice issues it (SENT). Consent applies: no text without OK-to-text or after STOP (the answer is SKIPPED with the reason). In test mode the message is logged as SENT_TEST.

Request bodyCopy Anchor Link

ExampleCopy Anchor Link

curl -X POST "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/messages/send" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"quote","recordId":"record_id","channel":"EMAIL","body":"string"}'

ResponseCopy Anchor Link

List text conversationsCopy Anchor Link

The Conversations inbox: customers' text conversations (a customer's texts, or a number's when it is nobody's) in which the customer texted or staff replied, newest first, with the last text and whether it is unread (the customer's newest text is newer than the last time anyone on the team opened it). unread=true keeps the ones waiting. unread in the answer counts every unread conversation. Read-only.

ParametersCopy Anchor Link

ExampleCopy Anchor Link

curl "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/conversations" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY"

ResponseCopy Anchor Link

Get a text conversationCopy Anchor Link

One text conversation, oldest first: the customer's texts and the business's (automated, sent by staff, with their status: queued, deferred, sent, delivered, failed), who sent each, whether it is unread, who a reply goes to and whether consent allows it (with the reason), and whether the business can text now (texting set up, A2P approved). Does not mark it read (POST /conversations/read). Read-only.

ParametersCopy Anchor Link

ExampleCopy Anchor Link

curl "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/conversations/thread" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY"

ResponseCopy Anchor Link

Mark a text conversation readCopy Anchor Link

Opening a conversation: it is read for the whole team (until the customer texts again) and the caller's own "New text from …" notifications for it are read. Changes nothing the customer sees.

Request bodyCopy Anchor Link

ExampleCopy Anchor Link

curl -X POST "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/conversations/read" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"customerId":"customer_id","phone":"+15555550123"}'

ResponseCopy Anchor Link

Text a customer (reply)Copy Anchor Link

Customer-facing: sends a free-form text (1–1,600 characters, sent as written; no merge fields) from the business's texting number to the customer's conversation, answering their newest text (recorded as sent by the caller). It goes to the number that last texted in, else the customer's mobile. Refused with the reason: texting not set up or the A2P 10DLC registration not approved (fix in Settings → Messaging), a number that replied STOP, a number marked not to text, texts turned off for the customer, or no OK to text when the number has not texted the business in the last 30 days (answering a customer who texted counts as consent for the reply, never for marketing). An answer goes now, even in quiet hours; a text that starts a conversation waits for the end of quiet hours (DEFERRED). In test mode it is logged as SENT_TEST. Supports Idempotency-Key.

Request bodyCopy Anchor Link

ExampleCopy Anchor Link

curl -X POST "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/conversations/reply" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"body":"string"}'

ResponseCopy Anchor Link