Homepage

sms_send

Last edit: Oct 13, 2026

Schedules an SMS to be sent in a background job, either rendered from an SMS
template defined in app/smses (template) or with the given content (sms). When
template is given, sms is ignored. The template's own delay setting applies.
Raises an error when the template does not exist

sms_send(
  data: HashObject
  sms: SmsSendInput
  template: NotificationTemplateInput
): SmsSendPayload

Arguments

data (HashObject)

Variables available in the Liquid of the template as data; used only with template

sms (SmsSendInput)

SMS to send without a template; required when template is not given

template (NotificationTemplateInput)

SMS template defined in app/smses to render and send

Type

SmsSendPayload

Autogenerated return type of SmsSend.

Questions?

We are always happy to help with any questions you may have.

contact us