UPupsmith
admin
test-sms

Send Test Sms

Send a one-shot SMS for admin testing.

Dispatches through the channel's provider — Twilio (SMS) or Telnyx (SMS_TELNYX). Bypasses the engagement / agent pipeline entirely: no Contact is created, no Engagement record is written, and inbound replies are NOT routed back to any agent. Use this only to verify SMS delivery for an org's configured SMS channel.

post/admin/test-sms/

Request

  • Base URL
    https://api-docs.upsmith.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Headers

organization-idstring nullable
timezonestring
x-user-idstring nullable
x-actor-emailstring nullable
x-request-sourcestring nullable
x-operation-idstring nullable
x-commit-messagestring nullable
x-confirmation-idstring nullable
x-chat-idstring nullable

Request body

organization_idstring required
to_numberstring required

Recipient phone number in E.164 format, e.g. +14155551234

messagestring required
channel_idstring nullable

Optional SMS channel id. If omitted, the first active SMS channel for the org is used.

Response

Successful Response

message_sidstring required
from_numberstring required
to_numberstring required
channel_idstring required

Changes

No recorded changes to this operation across all 1 revision of this API.