STstuut
sms

Request Partner Sms Consent

Request SMS Consent

Send the partner's outreach phone number an SMS asking them to opt in to receiving messages. Returns 409 if consent has already been requested from that number, whatever its current status.

post/v2/sms/consent/{partner_id}/request

Request

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

Path parameters

partner_idstring required

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 1 revision of this API.