Skip to content
Pidgely Docs

API reference · Templates

Create or replace a language variant (Pidgely extension)

PUThttps://api.pidgely.com/templates/{key}/languages/{locale}
View as Markdown

Manual translation, on every plan. A new language starts as a copy of the base: send only what differs. Fields left out of an existing language are kept. up_to_date: true marks it current with the base. Saved in the draft: publish the template to send it.

Authorization: Bearer pdg_…. An API key with full_access. A sending_access key gets 401 restricted_api_key.

Path parameters

Name Type Required Description
key string Yes Template id or alias
locale string Yes Language code (pt-br, es, ...; case and _ are normalised)

Body parameters

JSON object.

Name Type Required Description
subject string No Subject line, up to 998 bytes. Required unless a template provides it.
html string No Sending html without builder detaches the language into HTML.
text string No —
builder object | null No Builder document; html and text are rendered from it.
up_to_date boolean No Mark the language as matching the current base (no longer stale).

Request

This endpoint is not in the SDKs yet; call it over HTTP.

cURL
curl -X PUT 'https://api.pidgely.com/templates/key/languages/locale' \
  -H "Authorization: Bearer $PIDGELY_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "subject": "Hello from Acme",
  "html": "<p>Hello!</p>",
  "text": "Hello!",
  "builder": null,
  "up_to_date": false
}'

Response

200 OK with a JSON object.

Errors

Errors have the shape {"statusCode", "name", "message"}. See Errors for the full list.

Status Name When
401 missing_api_key, restricted_api_key No Authorization: Bearer header, or a sending_access key called an endpoint that needs full_access.
403 invalid_api_key, validation_error The API key is invalid or revoked, or the request is not allowed for this account (unverified domain, plan limit, paused account).
404 not_found The resource does not exist in this account (or the id is not a valid UUID).
422 validation_error A field is missing or invalid; message names it.
429 rate_limit_exceeded Too many requests per second. Wait for Retry-After seconds.