sms

Send SMS

Send a transactional TaScan SMS text to a worker (by worker_id, using their phone on file) or to a raw phone number. Optionally attach a task list — the recipient gets a tap-to-open checklist link. Sends from TaScan's carrier-registered A2P number (or the org's own Twilio if BYOK). Counts against the org's monthly SMS quota unless BYOK. Messages are auto-prefixed with "TaScan:" per carrier registration; transactional/work-related content only, no marketing. Attach images with media_url or media_base64 (MMS); message is optional when an image is attached.

post/sms

Request

  • Base URL: https://app.tascan.io/api/v1
  • URL: https://app.tascan.io/api/v1/sms
  • Auth: HTTP bearer

Request body

worker_idstring

Worker ID — sends to their phone on file (preferred over raw phone)

phonestring

Raw phone number (e.g. "+17025551234") — used when no worker_id given

messagestring

Message text. Transactional and work-related only.

list_idstring

Optional task list ID — appends a tap-to-open worker checklist link

include_linkboolean

When a list_id is given, append the tap-to-open link to the SMS body (default true). Set false to send the message text alone — the link is still returned for you to share another way.

idempotency_keystring

B1: optional replay key (up to 1024 chars, no braces) sent verbatim as the Idempotency-Key header instead of a fresh one per call — a retried call with the SAME key replays the original response instead of sending a second text.

media_base64string

Image to attach (MMS) as base64 bytes (data: URI accepted). JPEG, PNG or GIF, max 3.5 MB. Stored privately; sent via a short-lived link.

media_type'image/jpeg' | 'image/png' | 'image/gif'

MIME type of media_base64.

Response

Success. JSON body: { data: ... } or an error object { error, message }.

Changes

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