# Preview a wording

`POST https://api.parasend.com/v1/wordings/preview`

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

Authentication: `Authorization: Bearer <API key>` (a `ps_test_` key in test mode, `ps_live_` in live mode).
Send an `Idempotency-Key` header: a retry with the same key returns the first answer.

Shows a wording, saved or not, as its recipient gets it.

## Query parameters

- `locale` (string, optional): One of: `is`, `en`. Default: `"is"`.

## Body (application/json)

- `channel` (string, required): The channel to preview: `email` or `sms`. One of: `email`, `sms`.
- `message` (object, required): 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)
- `use` (string, optional): 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_id` (string · nullable, optional): The brand profile (`bp_…`) to preview with; null for Parasend's own look. Left out: your organisation's default profile.
- `sample_gender` (string, optional): The gender to fill in for {{recipient.gender: …}} in the preview. One of: `male`, `female`, `other`.

## Example: Preview a notice wording

```bash
curl -X POST "https://api.parasend.com/v1/wordings/preview" \
  -H "Authorization: Bearer $PARASEND_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "use": "notice",
    "channel": "email",
    "message": {
      "preset": "standard"
    }
  }'
```

```js
const res = await fetch('https://api.parasend.com/v1/wordings/preview', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.PARASEND_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    use: 'notice',
    channel: 'email',
    message: {
      preset: 'standard',
    },
  }),
});
const data = await res.json();
```

## Response 200

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

```json
{
  "object": "notice_preview",
  "channel": "email",
  "locale": "is",
  "preset": "standard",
  "template": {
    "id": "invitation.email",
    "version": 13
  },
  "email": {
    "from_name": "Sending frá: Fyrirtæki ehf.",
    "subject": "Sýnishorn af sendingu",
    "text": "Fyrirtæki ehf. hefur sent þér 1 skjal með Parasend.\n\nSýnishorn af sendingu\n1 skjal · aðgengilegt til 13. nóvember 2026\n\nSkilaboð frá sendanda:\nÞetta er sýnishorn. Svona birtist sendingin viðtakanda.\n\nOpna sendinguna: https://parasend.com/d/synishorn\nÞú staðfestir móttöku með rafrænum skilríkjum. Það tekur innan við mínútu.\n\nEr þetta öruggt? Parasend biður þig aldrei um lykilorð eða kortaupplýsingar. Móttaka sendingarinnar er skráð.\n\nIn English: Fyrirtæki ehf. has sent you 1 document through Parasend, an electronic registered delivery service. Open the delivery with the button above and confirm receipt.\n\n—\nÞessi tilkynning er frá Parasend. Sendandi: Fyrirtæki ehf.\nParasend er rekjanleg rafræn afhendingarþjónusta sem Justikal ehf. rekur, Akralind 3, 201 Kópavogi.\n",
    "html": "<!doctype html><html lang=\"is\"><head><meta charset=\"utf-8\"><meta name=\"viewport\" content=\"width=device-width,initial-scale=1\"><meta name=\"color-scheme\" content=\"light\"><title>Sýnishorn af sendingu</title></head><body style=\"margin:0;padding:0;background:#F5F6FA;\"><div style=\"display:none;max-height:0;overflow:hidden;\">Opnaðu sendinguna og staðfestu móttöku. Aðgengileg til 13. nóvember 2026.</div><table role=\"presentation\" width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" style=\"background:#F5F6FA;\"><tr><td align=\"center\" style=\"padding:20px 12px;\"><table role=\"presentation\" width=\"600\" cellpadding=\"0\" cellspacing=\"0\" style=\"width:100%;max-width:600px;\"><tr><td style=\"background:#FFFFFF;border:1px solid #E6E9F2;border-radius:12px;\"><table role=\"presentation\" width=\"100%\" cellpadding=\"0\" cellspacing=\"0\"><tr><td style=\"background:#0E1526;border-radius:12px 12px 0 0;padding:18px 28px;\"><table role=\"presentation\" cellpadding=\"0\" cellspacing=\"0\"><tr><td style=\"padding-right:9px;vertical-align:middle;\"><img src=\"cid:parasend-logo-v1\" width=\"22\" height=\"24\" alt=\"\" style=\"display:block;border:0;width:22px;height:24px;max-width:22px;\"></td><td style=\"vertical-align:middle;font-family:-apple-system,'Segoe UI',Helvetica,Arial,sans-serif;\"><div style=\"font-size:18px;font-weight:700;letter-spacing:-0.02em;line-height:1.1;color:#FFFFFF;\">Parasend</div><table role=\"presentation\" cellpadding=\"0\" cellspacing=\"0\" style=\"margin-top:4px;\"><tr><td style=\"vertical-align:middle;\"><table role=\"presentation\" cellpadding=\"0\" cellspacing=\"0\"><tr><td width=\"12\" height=\"3\" bgcolor=\"#EA553B\" style=\"width:12px;height:3px;background:#EA553B;border-radius:2px;font-size:3px;line-height:3px;\">&nbsp;</td></tr></table></td><td style=\"padding-left:6px;font-family:-apple-system,'Segoe UI',Helvetica,Arial,sans-serif;font-size:11.5px;font-weight:500;line-height:1.2;color:#9AA3BA;\">by Justikal</td></tr></table></td></tr></table></td></tr><tr><td style=\"padding:32px 36px 28px;font-family:-apple-system,'Segoe UI',Helvetica,Arial,sans-serif;color:#0E1526;\"><p style=\"margin:0;font-size:13px;font-weight:600;color:#147A52;\">Rekjanleg rafræn afhendingarþjónusta</p><h1 style=\"margin:8px 0 20px;font-size:24px;line-height:1.3;font-weight:700;color:#0E1526;\">Fyrirtæki ehf. hefur sent þér 1 skjal með Parasend</h1><table role=\"presentation\" width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" style=\"border:1px solid #E6E9F2;border-radius:12px;\"><tr><td style=\"padding:14px 16px;\"><p style=\"margin:0;font-size:16px;font-weight:600;\">Sýnishorn af sendingu</p><p style=\"margin:0;font-size:14px;color:#5B6472;padding-top:4px;\">1 skjal · aðgengilegt til 13. nóvember 2026</p></td></tr></table><table role=\"presentation\" width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" style=\"margin-top:16px;background:#EEF0F7;border-radius:12px;\"><tr><td style=\"padding:14px 16px;\"><p style=\"margin:0;font-size:12px;font-weight:600;color:#5B6472;\">Skilaboð frá sendanda</p><p style=\"margin:0;font-size:15px;line-height:1.55;color:#202C49;padding-top:4px;\">Þetta er sýnishorn. Svona birtist sendingin viðtakanda.</p></td></tr></table><table role=\"presentation\" width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" style=\"margin-top:22px;\"><tr><td align=\"center\" style=\"background:#C2452D;border-radius:12px;\"><a href=\"https://parasend.com/d/synishorn\" style=\"display:block;padding:15px 20px;font-family:-apple-system,'Segoe UI',Helvetica,Arial,sans-serif;font-size:16px;font-weight:600;color:#FFFFFF;text-decoration:none;\">Opna sendinguna</a></td></tr></table><p style=\"margin:0;font-size:14px;color:#5B6472;text-align:center;padding-top:10px;\">Þú staðfestir móttöku með rafrænum skilríkjum. Það tekur innan við mínútu.</p><p style=\"margin:0;font-size:13px;line-height:1.6;color:#5B6472;padding-top:20px;\">Virkar hnappurinn ekki? Opnaðu þennan hlekk í vafra:<br><a href=\"https://parasend.com/d/synishorn\" style=\"color:#C2452D;word-break:break-all;\">https://parasend.com/d/synishorn</a></p></td></tr></table></td></tr><tr><td style=\"height:16px;line-height:16px;font-size:0;\">&nbsp;</td></tr><tr><td style=\"background:#ECEEF4;border-radius:12px;padding:18px 24px;font-family:-apple-system,'Segoe UI',Helvetica,Arial,sans-serif;font-size:13px;line-height:1.6;color:#5B6472;\"><table role=\"presentation\" cellpadding=\"0\" cellspacing=\"0\"><tr><td style=\"padding:1px 12px 0 0;vertical-align:top;\"><img src=\"cid:safety-shield-v1\" width=\"20\" height=\"20\" alt=\"\" style=\"display:block;border:0;width:20px;height:20px;max-width:20px;\"></td><td style=\"vertical-align:top;font-family:-apple-system,'Segoe UI',Helvetica,Arial,sans-serif;font-size:13px;line-height:1.6;color:#5B6472;\"><b style=\"color:#202C49;\">Er þetta öruggt?</b> Parasend biður þig aldrei um lykilorð eða kortaupplýsingar. Móttaka sendingarinnar er skráð.</td></tr></table><p lang=\"en\" style=\"margin:0;padding:12px 0 0 32px;\">In English: Fyrirtæki ehf. has sent you 1 document through Parasend, an electronic registered delivery service. Open the delivery with the button above and confirm receipt.</p></td></tr><tr><td style=\"padding:16px 12px;font-family:-apple-system,'Segoe UI',Helvetica,Arial,sans-serif;font-size:12px;line-height:1.6;color:#5B6472;text-align:center;\">Þessi tilkynning er frá Parasend. Sendandi: Fyrirtæki ehf.<br>Parasend er rekjanleg rafræn afhendingarþjónusta sem Justikal ehf. rekur, Akralind 3, 201 Kópavogi.<br><a href=\"https://parasend.com/legal/privacy\" style=\"color:#C2452D;text-decoration:none;\">Persónuvernd</a></td></tr></table></td></tr></table></body></html>",
    "images": {
      "parasend-logo-v1": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEIAAABICAYAAABCzyOOAAAFiElEQVR4nOybXWzbVBTHz7UTUQECtibpeABVQCcxxAZUo02FilAR6gQbG0tG1T3xgqbxBNsjDyABQiAKT+wFaWi8pE2abUh8C9QCTVOV0mnAQHxtaIP1cx39WLs2vofj1IgJSneuY8fO5N+DbcXHvvbf9+Pcc25CEFAkBAFFAiEsAiEsAiEsPBdiPNHUZu6jmVwKPERAmcH6+vBEbbhVanobFb6NfrrWOjWLAO9q0khFTi19KIaGlqCMlEUITII+JuMPCiEepyJ3UKk3rH4BnKfNYRImFRO5T0UaDHAZ14SglxATicb7JehtVMpOKigCNqD7TNAmo4HRGcnke0XxJ+dxXIjRRLxJQPHLJ+nuN4KTIJylTVoXkKpO5/rBQRwRYjzZUC8xZH75XXTDm6EMIOJvmhBdYBipaDb/NZSIbSHOJeN3FopfHsyvfxt4Cv5MtSUVMqBz7eHct2ADJSFGtzfdqoXFbkkvTxduAB+CCN9pAJ2hgvHOmiP5U9zrWEJMJpviBogDdLgJKgnEYV2KvdXZvvzlTDVgIBE3QqWJYCLE3VKXGzmmgYttEQhhEQhhEQhhEQhhEQhhwRNC2J/okCv8vIo9OTY6DXubqMBGOo5CmeAJIQXyPI7/UpPJPQc2GXnsvluEJvfS9H0f2MV8dga81xNoU4bSWJf98lcScj/Vx2aqW7+DHTRkec+8F0QhwUNimb4v9FljA7WzH0CVK6FGXEr1BwPTiAbNdFHtozhaI3xCTffAcWomL4ELVJQQJvqc8Sq4QMUJYTYR2v0IDlNxQhRBuGx8QRVmZ+lO5NguCPIbcBjm8Fn+RNDqaI7HSJlNQ3M9waKCEHgP2xg11nDLC9WBXASfgMtx1ru49gJxgWPHEoJKngefMJZs2kNPFObaG0Jc4NjxhGDezG0mH918E2XRXlG6COUcx4wnhAFj4AMK4fBB+Cd7zkPqIxwz1jQc4eIZgCrwiumt9ZGFq6oOURttAUWqQsZpjh2rRkSzQ2dJjQJ4wFgy3jpfVXWCRNgCiiDg/PXp/nMcW36oTuBPtLkdHGI8GW+XKNavUJBGZdXSvo5ehc6LtXadGOpPTnBt2UKQTzVMD+SYEHS/duqEH175rPjX3mYZiOwsOXuuoSnc1C9ogEN8WyYUo/ocKgyKTfVybdlCRLK5QfLqxqFCoGc9GenuZ4f2lKbhNAl9DyoEqg1HVezV4hEouqBC0NBQWrepJEQ00/cR9cS+8DJXY7lZ5AdUrlFsGjQRBXEI/M8BRXv1UJ0mFzq88jKZzOKfM2+CIspCFN1twLfBryC+se7j46wZ56XYct2mtjfWLoX1kxzb/0sCU8HtNL+vA2eZ0mcLtVakWwnbPuxoIt4hhPY0+Aga3vdF07kOsIHtcH6VgBdoNwW+AX+xK4KJbSGK01sJe8APUPsThtwFJVBSgifW3ddFI0gaPEe8XOp67JIzXXJ65glyYNjzfufBXnL0noUSKVkIc6gKLS62ejMhw+/1WWPbsqNXGo7kPquPDp6mHvshEkN5/C6BP4RxscXOULkSjiWBY+ncMdrtgDJAfeOkJmXLsnPnDI5mw2vSfZ8INB6gDnQG3ALxDErtXpVYAwfHlwVEM/keCgY0mw8MToPwFYilzeYiM3AYV9ZHmM1EnzPuAKcCOdQWKDTfEZ0Ix2PpQVbCRhXX0/0Utn+SwvavU8T6arDHCAVhd0fSuc/ARcqy7mFsZ0MdaPpbVFyz0oWIB8OFC8+sOXLsPLhMWReAUCY7QUW+SIfrVzVE6BGisD+aHmCH40vFk5Uw44n4Iyi0p+iw9e/fzPQcxUSzAuVrse7+YSgzni4JmtzScJ28JrSV3ML52ET4fdHTw1rU4QY+WxvlHcH/NSwCISwCISwCISz+AgAA//8/kCtoAAAABklEQVQDAIko0UD+kjBJAAAAAElFTkSuQmCC",
      "safety-shield-v1": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADwAAAA8CAYAAAA6/NlyAAAGtUlEQVR4nOyaa2wUVRTHz5nZbWlBaXeLH9SofNGCkIghwUBbSsQHBsEulgRIBGLkER4GY4C2aBpDu1RD0FZFwAh8ICoru1SJxoTE2hYwKlEjLxsQX0SM+0Ab2C3dudczC8Wd2e32zuzMQkp/X2b3zn2c/9xzz8x9OOAmwwE3GUOCBztDgu2muGZ2uQzyQvW3AsruiLe1A3IIQi5YNSPfNWLYfAlwFbU4QXOPw3ccoTnUHX0fWj7rAZuxVXDJ2lm3c1leQT+XI2Jxpryc8whdtsbijpaLr/nOg03YIri4rqpM5rCaA1QhoKFhw4HHySi/gtASaQh0gsVYKthVU7UYEV4gkePAAkj8MTJxc6jRvwssImvBfW5LQpdQdSWZc/Mg57BdddsC7JHMlMvW3U0LNuS2mQJTpoCWUk327m5MsHHjAmRcs6hxlj3EDAgLdq2bc78k80/o5+jMOcn9AHcAXn4r1HDgHJjAXTfzDuB5KxD4cwO7O5wFKT4juPHjn0AAYcHuWs9Oyryo3wx2vE9FPYrzHUFvYAkIIPzKQM5HA6Z7PnyvwrE54vUfAquhBxcG2Em/dhbVeSocnK8kS6rT5LwXBDH9aUlR8xRIl6ebdVujXGjwt9OlPeHuLO8gPftSMIEEJqHx9VeuxCajtqm2DSYZmi0NdoYED3ZuOMHF62beJaFjFpd5a7ih9XewGNNR2g6Ka6vGyVLetyhJLRKTj7rWeu4Ei7lhBJdsmHWfDPAFve9GJRLoKslQDxZzQ7i0KhaY3Cnw3Zw1172H1UkJV+RDerG05BNiynXsYZqyKbov6X4flmjgcdXMHovAvqT1Lreusb85k6aFX933Rz9FJdDZBoKI9zDiP7pGitJlU8VqAg/1YLp8ajqC1K4Xm+hZhtPCTfuOQz/QrEy/IHgBBBEWjBzC2gR0pa1Qcr6iDTysLTFGk1D/q+kpPUtzaZSVKZnEXqkW3Lr/IRBEWDBDrhFMD8AlVpLGJgWkPtH9BygeBEkpE5nI0wKD1itQ1xkZEO9hwIguoUCdoOvzcYm9RO6uM4DEKY4OV43nafWaIpbGLONsqojYUfXVI6hH87Sm2NDDHFmXPq3olvwx+jQ1SHEFK64urCdbNUpC8F1z9/9rDoIcLw97W0+AACymjEm1DbpAEGHBvQzbUgpzqTJdXnUMMsam0kJexmBy5dUjVYquR6mgxCv1ab1Oh/D+lLDgbm8gRK76q6ZxTG28j0hT649MYRWp7n0V9dUDrGKgAJVaDit1CWf+rfdZP4ZVaF3rsPY/PA71Txb2l18Vnda9DbpxH7TofwuVfVhTE8fDRuowJJgjHtEkIOa7Y85Fmcok3Buhgizrumphl1E3vta+LC9W29SmsiNgAGOC4xAgF2WaROTLBioXaQwcC+Y7xgNj89WrYTfua0pdrk22hyzq6cV9YADDWy20Pv0RFZqjaRjZpFDD/q/BRoprPFNkBN0OBv8g2BiYBwYwPHlAxt5MTcMmsBkS26hPYxyawSCGBQc37W+jIKQNNoiVJeurFoBNkFctokuFNpV/H/YGDI1fFXPTQ47PpybBG8XrqkeCxdxaX+2iwfq6Pp12O1aCCUwJDm3yH6Re3p2cpk4EJDnuoxmsdXNsqsvZo3xIuwzaB0l7SWa3dkwbx/Njq0G3A0BR9BF3T9W7YBFU13skdrqmXYBzwd6La8AkMpgk2na6J7+89Djt7GnGLvX0hIKyMdFo58msNtfcNZ4NVFeKMJopzY02HTgJJjEtWCXWcer0sLLSbjLsMe0dPn14xVi81HGyDYyDFKQaqWdf1t+gqLwm7PXvgSyw5FAL9cbbZOByfTp9GLSGoo55sMUXFaroxUeHlzhH7CWrnkhzd3uw0b8UssSqUzzUK1Wfq2M45Q6H0zRHXjDQh4mrbvZkZNIe8pZ70tTxadDrn5n4lSVZuXQy0QdG7y3Md9CqBmrXsFBdGcFnh5eXFl2aOL4dvjoR19xfU13gnla6BTm+k/7wGvcFQ7/NhaN/Ci/UZcLyg2nU03XU0xvT3uRwngHfehkcW6E3jsOcoJ7SW0aR7raUrARdakPewCawEFtO4pWsf6qSS9IuqvxuMMdZhSsL7Th4aplLJ3Op89Qv0YnjthU6WSG9Riah4IOlPlUo+G0Jdkc9sc0HfgYbsP00ravO85DE6KsMMePBk8SZEQ7P0FfcN2AjuTk+XF/pcMVcc1CC1dTgZO1N3skYNIfPOPzg81kSmDKRG8FJjKz1POgEWKq6r8L4tgtNgR8gh+Rc8PVm6MjDYGdI8GDnPwAAAP//Q/PBygAAAAZJREFUAwBNHsTsz47Z7QAAAABJRU5ErkJggg=="
    }
  }
}
```

Errors: one shape, `{"error": {type, code, message, param, request_id}}`; every code is listed at https://parasend.com/docs/errors.