# Saved wordings

Source: https://parasend.com/docs/api/wordings

Reminder/escalation and notification policies. Escalation steps `{after_days, channel, conditions[], min_score?, requires_approval?}` with channels email | sms | alternate_email | paper.

## Endpoints

- [Save a wording](https://parasend.com/docs/api/wordings/create.md): `POST /v1/wordings`
- [List saved wordings](https://parasend.com/docs/api/wordings/list.md): `GET /v1/wordings`
- [Retrieve a saved wording](https://parasend.com/docs/api/wordings/retrieve.md): `GET /v1/wordings/{id}`
- [Update a saved wording](https://parasend.com/docs/api/wordings/update.md): `PATCH /v1/wordings/{id}`
- [Archive a saved wording](https://parasend.com/docs/api/wordings/archive.md): `DELETE /v1/wordings/{id}`
- [List a wording's versions](https://parasend.com/docs/api/wordings/versions.md): `GET /v1/wordings/{id}/versions`
- [Retrieve a wording version](https://parasend.com/docs/api/wordings/version.md): `GET /v1/wordings/{id}/versions/{version}`
- [Preview a wording](https://parasend.com/docs/api/wordings/preview.md): `POST /v1/wordings/preview`
- [Check what wordings may contain](https://parasend.com/docs/api/wordings/capabilities.md): `GET /v1/wordings/capabilities`

## The Wording object

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

- `id` (string, optional): The wording's ID, starting `wrd_`.
- `object` (string, optional): Always `wording`.
- `name` (string, optional): Your name for the wording, 1–100 characters. Recipients never see it.
- `use` (string, optional): `notice` or `reminder`; fixed once the wording is made. One of: `reminder`, `notice`.
- `channel` (string, optional): The channel the wording is for, `email` or `sms`; fixed once the wording is made. One of: `email`, `sms`.
- `is_default` (boolean, optional): The first-notice wording for its channel.
- `version` (integer, optional): The current version's number: 1 for the first, one more for each change to `message`.
- `version_id` (string, optional): The wording version's ID, starting `wrv_`.
- `message` (object, optional): 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.
  - `message.preset` (string, optional): `standard` is the usual reminder; `firmer` and `final` are Parasend's stronger wordings. One of: `standard`, `firmer`, `final`. Default: `"standard"`.
  - `message.custom` (object, optional): 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`.
    - `message.custom.is` (object, optional): 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}}.
      - `message.custom.is.subject` (string, optional): One line. Empty is the preset's.
      - `message.custom.is.heading` (string, optional): One line, in place of the reminder's heading.
      - `message.custom.is.text` (string, optional): A paragraph under the heading; for an SMS, between the sender's name and the link (3.5).
    - `message.custom.en` (object, optional): 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}}.
      - `message.custom.en.subject` (string, optional): One line. Empty is the preset's.
      - `message.custom.en.heading` (string, optional): One line, in place of the reminder's heading.
      - `message.custom.en.text` (string, optional): A paragraph under the heading; for an SMS, between the sender's name and the link (3.5).
  - `message.source` (object, optional): 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.
    - `message.source.wording` (string, required)
    - `message.source.version` (integer, required)
- `created_at` (string · date-time, optional): When the wording was saved, in ISO 8601 (UTC).
- `updated_at` (string · date-time, optional): When the wording last changed (renamed, given a new version, made or no longer the default, or archived), in ISO 8601 (UTC).
- `archived_at` (string · date-time · nullable, optional): 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_by` (object, optional): How many follow-up policies use this wording, and how many of them use an older version.
  - `used_by.policies` (integer, optional)
  - `used_by.policies_on_older_version` (integer, optional)

```json
{
  "id": "wrd_01M6R27T6WN5ZPHV4DA9SGQ3G6",
  "object": "wording",
  "name": "Second reminder",
  "use": "reminder",
  "channel": "email",
  "is_default": false,
  "version": 1,
  "version_id": "wrv_01M6R27T6WR1V5QFE0E3SKRHNW",
  "message": {
    "preset": "firmer"
  },
  "created_at": "2026-11-06T09:15:05.820Z",
  "updated_at": "2026-11-06T09:15:05.820Z",
  "archived_at": null,
  "used_by": {
    "policies": 0,
    "policies_on_older_version": 0
  }
}
```