sms

Create Sms Draft Message

Create SMS Draft

Create an SMS draft message for a partner. The body can be provided directly, generated from a template, or generated by an LLM.

post/v2/sms/messages

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Request body

invoicesstring[] required

Invoice IDs to link to the SMS; may be empty with a manual body

partner_idstring required

Partner ID to send the SMS to

sms_template_idstring nullable

SMS template ID to render

bodystring nullable

Manual SMS body text

Response

Successful Response

created_atstring date-time required
modified_atstring date-time nullable required
idstring required
bodystring required

The message content

direction'inbound' | 'outbound' required
from_numberstring phone required

The sending phone number

to_numberstring phone required

The receiving phone number

status'draft' | 'pending' | 'sent' | 'delivered' | 'failed' | 'undelivered' required
is_automatedboolean required

Whether the SMS was automatically sent by a workflow

sent_atstring date-time nullable required
delivered_atstring date-time nullable required
error_messagestring nullable required

Twilio error message if delivery failed

objectstring required

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

Changes

No recorded changes to this operation across all 2 revisions of this API.