Preview a follow-up step

Query parameters

• localestring
  One of is en
  Default "is"

Body

Required

• stepobjectrequired

  One step of a follow-up policy: after after_days (a whole number of days, 1–365, never earlier than the step above), send a reminder by email or sms, with the wording in message. alternate_email and paper steps are refused (policy_step_invalid) until the contact lookup and paper mail are available. Responses add available: false for a step that cannot run yet (only rpol_debt_collection's paper step).

  5 fields of step

  • step.after_daysintegerrequired

    Days after the first notice when the step is due: a whole number from 1 to 365, never smaller than the step before it. The reminder goes within the send window and at least 24 hours after the delivery's last message.

    at least 1, at most 365
  • step.channelstringrequired

    How the step's reminder goes: email or sms. A step whose channel the recipient has no contact for is skipped. alternate_email and paper are refused with policy_step_invalid until they are available.

    One of email sms alternate_email paper
  • step.conditionsarray of string

    What must all hold for the step to go, else it is skipped: not_delivered (always included, listed or not); email_not_opened, no e-mail to the recipient has been opened (a hint, not proof); email_bounced, an e-mail to the recipient bounced or failed.

    One of not_delivered email_not_opened email_bounced
  • step.requires_approvalboolean · nullable

    Paper defaults to approval-required.

  • step.messageobject

    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

    • step.message.presetstring

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

      One of standard firmer final
      Default "standard"
    • step.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

      • step.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}}.

      • step.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}}.

    • step.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

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

Optional

• brand_profile_idstring · nullable

Returns

200 application/json. The rendered step.

Errors have one shape; see Errors for every code.