Skip to main content
POST
/
v2
/
sms-threads
/
messages
Create Sms
curl --request POST \
  --url https://api.example.com/v2/sms-threads/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "invoices": [
    "<string>"
  ],
  "partner_id": "<string>",
  "sms_template_id": "<string>",
  "body": "<string>",
  "options": {
    "use_llm": false,
    "include_payment_url": false
  }
}
'
{
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "sms_thread_id": "<string>",
  "body": "<string>",
  "classifications": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "action_recommendation": "<string>",
      "agent_confidence_score": 123,
      "agent_metrics": {
        "confidence_reason": "<string>",
        "confidence_score": 123,
        "uncertainties": [
          "<string>"
        ]
      },
      "evidence": {},
      "is_action_required": true,
      "is_reply_required": true,
      "language": "<string>",
      "reason": "<string>",
      "object": "<string>"
    }
  ],
  "from_number": "<string>",
  "to_number": "<string>",
  "is_automated": true,
  "sent_at": "2023-11-07T05:31:56Z",
  "delivered_at": "2023-11-07T05:31:56Z",
  "error_message": "<string>",
  "object": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.api.stuut.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body for creating an SMS draft.

Exactly one body source must be provided: body, sms_template_id, or options.use_llm.

​
invoices
string[]
required

List of invoice IDs to link to the SMS

Minimum array length: 1
​
partner_id
string
required

Partner ID to send the SMS to

​
sms_template_id
string | null

SMS template ID to render

​
body
string | null

Manual SMS body text

​
options
object

Options for SMS draft creation.

Response

Successful Response

SMS message within a thread.

​
created_at
string<date-time>
required
​
modified_at
string<date-time> | null
required
​
id
string
required
​
sms_thread_id
string | null
required
​
body
string
required

The message content

​
classifications
InteractionClassification · object[]
required
​
direction
enum<string>
required
Available options:
inbound,
outbound
​
from_number
string<phone>
required

The sending phone number

​
to_number
string<phone>
required

The receiving phone number

​
status
enum<string>
required
Available options:
draft,
pending,
sent,
delivered,
failed,
undelivered
​
is_automated
boolean
required

Whether the SMS was automatically sent by a workflow

​
sent_at
string<date-time> | null
required
​
delivered_at
string<date-time> | null
required
​
error_message
string | null
required

Twilio error message if delivery failed

​
object
string
required
read-only

String representing the object's type. Objects of the same type share the same value.