# Update a message template

```http
PUT https://secure.yoprint.com/v2/api/store/{team_slug}/setting/message_template/{hash_id}
```

- API version: v2
- Operation ID: `v2_public_message_template_update_put`
- Section: Team settings › [Message templates](https://developer.yoprint.com/reference/message-templates.md)
- Web page: https://developer.yoprint.com/reference/message-templates/v2-message-template-update-put/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Changes a template's name, subject, body or button settings. Send only what changes. System templates can be edited too.

Use PUT. PATCH runs no rules and changes only `options`, which in practice aren't saved (see `options`).

Attachments are changed with the attachment operations. The type can't change.

**Placeholders.** `subject` and `body` are Liquid: write `{{order_number}}` and YoPrint fills it in from the record when the message is made.

- Sales orders and quotes: `order_number` (`quote_number` on quote templates), `order_label`, `order_link`, `issue_date`, `cust_due_date`, `client_note`, `total`, `download_url`, `creator.name`, `customer_name`, `customer_id`, `customer_portal_url`, `deposit_remaining`, `balance_remaining`, `package_tracking`, `customer_po_number`.
- Purchase orders: `order_label`, `order_number`, `issue_date`, `due_date`, `note`, `total`, `download_url`, `creator.name`, `creator.email`.

Each template's `supported_placeholder` lists its own, with labels. The body is HTML for emails and plain text for text messages.

## Permission

Needs the Manage Settings permission. The team owner always has it.

## Side effects

- Team members who have YoPrint open see the change at once.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.
- `hash_id` (string, required): The message template. Its hash id from an earlier answer; there is no unique key for it. Example `DVubREua5aJkwh`.

## Request body

Content type `application/json`, required.

Fields:

- `body` (string, optional): Liquid.
- `name` (string, optional)
- `options` (object, optional): Email button settings. Accepted but, in practice, not saved: YoPrint keeps them only on a template that already has button settings, and templates made through the API or by YoPrint have none. They are not returned when you read a template. Preview does use them.
  - `button_label` (string, optional): Required when `enable_button` is true.
  - `button_link` (string, optional): Required when `enable_button` is true.
  - `enable_button` (boolean, optional)
- `subject` (string, optional): Liquid.

### Example request

```bash
curl -X PUT 'https://secure.yoprint.com/v2/api/store/your-team/setting/message_template/DVubREua5aJkwh' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1' \
  -H 'Content-Type: application/json' \
  -d '{
    "body": "<p>Hi {{customer_name}}, order #{{order_number}} is ready. Total: {{total}}.</p>",
    "name": "Ready for pickup"
  }'
```

## Response

`200` Successful response.

Fields:

- `data` (object, required)
  - `body` (string, required): Liquid: HTML for emails, plain text for text messages.
  - `can_create` (boolean, required)
  - `can_delete` (boolean, required)
  - `can_update` (boolean, required)
  - `created_at` (string (date-time), required)
  - `id` (string, required)
  - `internal_attachments` (array of objects, required): Its attachments, as the attachment operations return them.
    - Each item:
      - `created_at` (string (date-time), required)
      - `detail` (string | null, required): For a document attachment, defaults to its kind, such as `Sales Order/Quote (PDF)`.
      - `id` (string, required)
      - `media` (object | null, required): For a `media` or `reference_media` attachment, the file: `id`, `name`, `file_name`, `mime_type`, `size`, a download `url`, a signed `view_url` and more. Null for document attachments.
      - `media_id` (string | null, required)
      - `name` (string | null, required)
      - `options` (string | null, required): The attachment's options as a JSON-encoded string, not an object: `"[]"`, or for job sheets `"{\"show_mockup\":true}"`. `"null"` for a `media` or `reference_media` file. Decode it before use.
      - `order_id` (string | null, required)
      - `order_scoped_id` (string | integer | null, required)
      - `purchase_order_id` (string | null, required)
      - `purchase_order_scoped_id` (string | integer | null, required)
      - `type` (string, required)
      - `updated_at` (string (date-time), required)
  - `name` (string, required)
  - `subject` (string | null, required): Liquid, as saved; null when none was saved. Only the three system types use a subject (`support_subject: true`).
  - `support_attachments` (boolean, required): True for every type, text messages included.
  - `support_subject` (boolean, required): True for the three system types only. The six saved types have no subject line of their own.
  - `supported_attachments` (array of strings, required): The attachment `type` values this template can carry.
  - `supported_placeholder` (array of objects, required)
    - Each item:
      - `label` (string, required)
      - `value` (string, required): Write it in the template as `{{value}}`.
  - `system` (boolean, required): A system template: YoPrint's own email for new documents. It can be edited but not created or deleted.
  - `type` (string, required): One of: `"new_sales_order_message"`, `"new_quote_message"`, `"purchase_order"`, `"sales_order_message"`, `"sales_order_text_message"`, `"quote_message"`, `"quote_text_message"`, `"purchase_order_message"`, `"purchase_order_text_message"`.
  - `updated_at` (string (date-time), required)
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": {
    "body": "<p>Hi {{customer_name}}, order #{{order_number}} is ready. Total: {{total}}.</p>",
    "can_create": true,
    "can_delete": true,
    "can_update": true,
    "created_at": "2026-10-01T09:00:00+00:00",
    "id": "DVubREua5aJkwh",
    "internal_attachments": [],
    "name": "Ready for pickup",
    "subject": null,
    "support_attachments": true,
    "support_subject": false,
    "supported_attachments": [
      "media",
      "reference_media",
      "order",
      "order_compact",
      "so_jobs_with_mockup",
      "so_jobs_without_mockup",
      "so_invoices",
      "so_compact_invoices"
    ],
    "supported_placeholder": [
      {
        "label": "Order Number",
        "value": "order_number"
      },
      {
        "label": "Customer Name",
        "value": "customer_name"
      }
    ],
    "system": false,
    "type": "sales_order_message",
    "updated_at": "2026-11-03T10:00:00+00:00"
  },
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
  - When: Your role lacks Manage Settings. The body is `{"message": "Insufficient Permission"}`, without the error envelope. Fix: Use the key of a member whose role has Manage Settings, or the owner's.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.
  - When: No template of your team has this id. `error.code` is null; `error.message` names the record type. Fix: Use an id from the list.
- `422` The request was refused and changed nothing. `validation_failed` lists what to fix in `error.fields`; other codes name a business rule, explained in `error.message`. A few checks answer with only `{"message": "..."}`. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer `connect_timeout` ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.
  - When: `subject` or `body` is not valid Liquid, or a button is enabled without a label and link (`validation_failed`). Fix: Fix the template text.

## Related

- [Get a message template](https://developer.yoprint.com/reference/message-templates/v2-message-template-show.md): `GET /v2/api/store/{team_slug}/setting/message_template/{hash_id}`
- [Preview template text](https://developer.yoprint.com/reference/message-templates/v2-message-template-preview.md): `POST /v2/api/store/{team_slug}/setting/message_template/preview`