Save a wording

POST/v1/wordings

Version 1 of a named wording for one channel. message follows a step's rules (StepMessage, without source); its custom needs Plan 1–3 or Enterprise (403 theme_knob_plan_gated, param message.custom); an SMS wording must keep the reminder one SMS (policy_sms_too_long).

Body

Required

namestringrequired

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

The channel the wording is for: email or sms. It cannot be changed later; an SMS wording's text must keep the message to one SMS.
One of email sms
messageobjectrequired

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

Optional

usestring

reminder (the default) for follow-up steps, or notice for the first notice.
One of reminder notice
Default "reminder"
is_defaultboolean

Notice wordings only: make this the first-notice wording for its channel. One per channel.
Default false

Returns

201 application/json. Saved. See the Wording object.

Errors have one shape; see Errors for every code.

curl -X POST "https://api.parasend.com/v1/wordings" \ -H "Authorization: Bearer $PARASEND_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "name": "Second reminder", "channel": "email", "message": { "preset": "firmer" } }'

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

import os, requests, uuid res = requests.post( "https://api.parasend.com/v1/wordings", headers={ "Authorization": f"Bearer {os.environ['PARASEND_KEY']}", "Idempotency-Key": str(uuid.uuid4()), }, json={ "name": "Second reminder", "channel": "email", "message": { "preset": "firmer", }, }, ) data = res.json()

using var http = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Post, "https://api.parasend.com/v1/wordings"); request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("PARASEND_KEY")); request.Headers.Add("Idempotency-Key", Guid.NewGuid().ToString()); request.Content = new StringContent(""" { "name": "Second reminder", "channel": "email", "message": { "preset": "firmer" } } """, Encoding.UTF8, "application/json"); var response = await http.SendAsync(request); var body = await response.Content.ReadAsStringAsync();

var json = """ { "name": "Second reminder", "channel": "email", "message": { "preset": "firmer" } } """; var request = HttpRequest.newBuilder(URI.create("https://api.parasend.com/v1/wordings")) .header("Authorization", "Bearer " + System.getenv("PARASEND_KEY")) .header("Idempotency-Key", UUID.randomUUID().toString()) .header("Content-Type", "application/json") .method("POST", HttpRequest.BodyPublishers.ofString(json)) .build(); var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

$client = new GuzzleHttp\Client(); $response = $client->request('POST', 'https://api.parasend.com/v1/wordings', [ 'headers' => [ 'Authorization' => 'Bearer ' . getenv('PARASEND_KEY'), 'Idempotency-Key' => bin2hex(random_bytes(16)), ], 'json' => [ 'name' => 'Second reminder', 'channel' => 'email', 'message' => [ 'preset' => 'firmer', ], ], ]); $data = json_decode($response->getBody(), true);

{ "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 } }