Saved wordings

Endpoints

• POSTSave a wording/v1/wordings
• GETList saved wordings/v1/wordings
• GETRetrieve a saved wording/v1/wordings/{id}
• PATCHUpdate a saved wording/v1/wordings/{id}
• DELArchive a saved wording/v1/wordings/{id}
• GETList a wording's versions/v1/wordings/{id}/versions
• GETRetrieve a wording version/v1/wordings/{id}/versions/{version}
• POSTPreview a wording/v1/wordings/preview
• GETCheck what wordings may contain/v1/wordings/capabilities

The Wording object

A saved wording: your organisation's text for notices or follow-up steps, kept with its versions.

• idstring

  The wording's ID, starting wrd_.

• objectstring

  Always wording.

• namestring

  Your name for the wording, 1–100 characters. Recipients never see it.

• usestring

  notice or reminder; fixed once the wording is made.

  One of reminder notice
• channelstring

  The channel the wording is for, email or sms; fixed once the wording is made.

  One of email sms
• is_defaultboolean

  The first-notice wording for its channel.

• versioninteger

  The current version's number: 1 for the first, one more for each change to message.

  at least 1
• version_idstring

  The wording version's ID, starting wrv_.

• 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

  • 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
• created_atstring · date-time

  When the wording was saved, in ISO 8601 (UTC).

• updated_atstring · date-time

  When the wording last changed (renamed, given a new version, made or no longer the default, or archived), in ISO 8601 (UTC).

• archived_atstring · date-time · nullable

  When the wording was archived with DELETE /wordings/{id}, in ISO 8601 (UTC); null while it is in use. Policies that loaded it keep their copy.

• used_byobject

  How many follow-up policies use this wording, and how many of them use an older version.

  2 fields of used_by

  • used_by.policiesinteger
    at least 0
  • used_by.policies_on_older_versioninteger
    at least 0