Preview a wording

Query parameters

• localestring
  One of is en
  Default "is"

Body

Required

• channelstringrequired

  The channel to preview: email or sms.

  One of email sms
• messageobjectrequired

  The wording a follow-up step's reminder sends. Left out: Parasend's standard reminder. preset picks Parasend's wording; custom holds your own, by language (Plan 1–3 and Enterprise). A field or language left out comes from the preset.

  3 fields of message

  • message.presetstring

    standard is the usual reminder; firmer and final are Parasend's stronger wordings.

    One of standard firmer final
    Default "standard"
  • message.customobject

    Your own wording, by language (is, en); a field or a language left out comes from preset. Needs Plan 1–3 or Enterprise; otherwise refused with theme_knob_plan_gated.

    2 fields of custom

    • message.custom.isobject

      Plain text. An e-mail step takes subject, heading and text; an SMS step text only. Variables: {{recipient.name}}, {{recipient.first_name}}, {{sender.name}}, {{delivery.title}}, {{delivery.sent_on}}, {{delivery.expires_on}}, {{files.count}}; an SMS only the two dates. No links, e-mail addresses or phone numbers. An e-mail may hold the gender word {{recipient.gender: male | female | other}}.

      3 fields of is

      • message.custom.is.subjectstring

        One line. Empty is the preset's.

        at most 150 characters
      • message.custom.is.headingstring

        One line, in place of the reminder's heading.

        at most 150 characters
      • message.custom.is.textstring

        A paragraph under the heading; for an SMS, between the sender's name and the link (3.5).

        at most 1500 characters
    • message.custom.enobject

      Plain text. An e-mail step takes subject, heading and text; an SMS step text only. Variables: {{recipient.name}}, {{recipient.first_name}}, {{sender.name}}, {{delivery.title}}, {{delivery.sent_on}}, {{delivery.expires_on}}, {{files.count}}; an SMS only the two dates. No links, e-mail addresses or phone numbers. An e-mail may hold the gender word {{recipient.gender: male | female | other}}.

      3 fields of en

      • message.custom.en.subjectstring

        One line. Empty is the preset's.

        at most 150 characters
      • message.custom.en.headingstring

        One line, in place of the reminder's heading.

        at most 150 characters
      • message.custom.en.textstring

        A paragraph under the heading; for an SMS, between the sender's name and the link (3.5).

        at most 1500 characters
  • message.sourceobject

    The saved wording and version this step's wording was loaded from. A record only: the step keeps its own copy. Not on a saved wording's own message.

    2 fields of source

    • message.source.wordingstringrequired
    • message.source.versionintegerrequired
      at least 1

Optional

• usestring

  What the wording is for: reminder (the default), a follow-up step's reminder, or notice, the first notice (whose message.preset must be standard).

  One of reminder notice
  Default "reminder"
• brand_profile_idstring · nullable

  The brand profile (bp_…) to preview with; null for Parasend's own look. Left out: your organisation's default profile.

• sample_genderstring

  The gender to fill in for {{recipient.gender: …}} in the preview.

  One of male female other

Returns

200 application/json. The message, drawn by the code that sends it (object notice_preview or reminder_step_preview).

Errors have one shape; see Errors for every code.