Follow-up policies

Endpoints

• POSTCreate a follow-up policy/v1/reminder_policies
• GETList follow-up policies/v1/reminder_policies
• GETRetrieve a follow-up policy/v1/reminder_policies/{id}
• PATCHUpdate a follow-up policy/v1/reminder_policies/{id}
• DELDelete a follow-up policy/v1/reminder_policies/{id}
• GETList a follow-up policy's versions/v1/reminder_policies/{id}/versions
• POSTPreview a follow-up step/v1/reminder_policies/preview
• POSTDuplicate a follow-up policy/v1/reminder_policies/{id}/duplicate
• POSTReset one of Parasend's policies/v1/reminder_policies/{id}/reset

The ReminderPolicy object

• namestringrequired

  Your name for the policy: 1–100 characters, without control characters; leading and trailing spaces are trimmed.

  at most 100 characters
• stepsarray of objectrequired
  6 fields of steps

  • steps[].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
  • steps[].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
  • steps[].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
  • steps[].requires_approvalboolean · nullable

    Paper defaults to approval-required.

  • steps[].availableboolean

    Responses only. False for a step that cannot run yet and is skipped (only the paper step of rpol_debt_collection); true otherwise.

  • steps[].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

    • steps[].message.presetstring

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

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

      • steps[].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}}.

      • steps[].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}}.

    • steps[].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

      • steps[].message.source.wordingstringrequired
      • steps[].message.source.versionintegerrequired
        at least 1
• stop_onstring

  When the follow-ups stop: confirmed, the only value, once the recipient confirms receipt.

• is_account_defaultboolean

  The organisation's pre-fill for new batches and deliveries; never applied by itself. Needs organization.update.

  Default false
• idstring

  The policy's ID. Parasend's own policies are rpol_default, rpol_debt_collection and rpol_none.

• objectstring

  Always reminder_policy.

• systemboolean

  One of Parasend's own policies (rpol_default, rpol_debt_collection, rpol_none). The steps of the first two can be made your organisation's own version (customized); none can be renamed or deleted.

• customizedboolean

  Your organisation's own version of one of Parasend's policies is in use.

• versioninteger

  The version in use in this organisation — for one of Parasend's, its own while customized.

• version_idstring

  The follow-up policy version's ID, starting rpv_.

• in_use_by_batchesinteger

  Open batches (draft or sending) that name the policy.

• in_use_by_deliveriesinteger

  Deliveries that cite the policy and are not yet confirmed or ended.

• created_atstring · date-time

  When the policy was created, in ISO 8601 (UTC).

• updated_atstring · date-time

  When the policy last changed (renamed, given a new version, or archived), in ISO 8601 (UTC). For one of Parasend's policies with your own version, when your version last changed.

• archived_atstring · date-time · nullable

  When the policy was archived with DELETE /reminder_policies/{id}, in ISO 8601 (UTC); null while it is in use. Parasend's own policies are never archived.