# Create a message template

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

- API version: v2
- Operation ID: `v2_public_message_template_store`
- 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-store/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Saves a new email or text message template for sales orders, quotes or purchase orders. You can add its attachments in the same request.

Only the six saved types can be created: `sales_order_message`, `sales_order_text_message`, `quote_message`, `quote_text_message`, `purchase_order_message` and `purchase_order_text_message`. The system types are set up with each new team; edit them instead.

**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.

Attachment `type` values: `order` (the sales order or quote PDF), `order_compact` (its compact PDF), `so_jobs_with_mockup` and `so_jobs_without_mockup` (job sheets), `so_invoices` and `so_compact_invoices` (its invoices), `purchase_order` (the purchase order PDF), and `media` or `reference_media` (a file, by `media_id`). A template accepts only the values in its `supported_attachments`: purchase order templates take `purchase_order`, `media` and `reference_media`.

## Permission

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

## Business rules

- System types can't be created (422 `system_template`).
- Inline attachments take document types only; add `media` and `reference_media` files with "Add an attachment to a template".
- `subject` and `body` must be valid Liquid; a syntax error is refused with 422.
- Each attachment `type` must be one the template supports. The template and its attachments are saved together or not at all.

## Side effects

- Team members who have YoPrint open see the new template 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`.

## Request body

Content type `application/json`, required.

Fields:

- `body` (string, required): Liquid. Must be valid Liquid. HTML for emails, plain text for text messages.
- `name` (string, required): What people pick from.
- `type` (string, required): One of: `"sales_order_message"`, `"sales_order_text_message"`, `"quote_message"`, `"quote_text_message"`, `"purchase_order_message"`, `"purchase_order_text_message"`.
- `internal_attachments` (array of objects, optional): Document attachments to add with the template. A `media` or `reference_media` attachment can't be added here: this call doesn't decode `media_id`, so it fails validation. Add files afterwards with "Add an attachment to a template".
  - Each item:
    - `type` (string, required): What to attach. Must be in the template's `supported_attachments`. One of: `"order"`, `"order_compact"`, `"so_jobs_with_mockup"`, `"so_jobs_without_mockup"`, `"so_invoices"`, `"so_compact_invoices"`, `"purchase_order"`, `"media"`, `"reference_media"`.
    - `detail` (string, optional)
    - `media_id` (string, optional): Required for `media`: the id of a file you uploaded. `reference_media` also needs an existing file.
    - `name` (string, optional): A name for the attachment.
    - `options` (object, optional)
      - `show_mockup` (boolean, optional): For `so_jobs_with_mockup` and `so_jobs_without_mockup`: `true` puts each job's mockup pages in the job sheets, `false` leaves them out. It overrides the type's own choice. Text such as `"true"` or `"off"` is accepted too; any other value is refused with 422 `validation_failed`. Other types ignore it.
- `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; must be valid Liquid. These six types have no subject line of their own: a subject is saved, but compile, preview and send don't use it.

### Example request

```bash
curl -X POST 'https://secure.yoprint.com/v2/api/store/your-team/setting/message_template' \
  -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}}, your order #{{order_number}} is ready for pickup at 100 Example Street.</p>",
    "internal_attachments": [
      {
        "name": "Sales order PDF",
        "type": "order"
      }
    ],
    "name": "Ready for pickup",
    "type": "sales_order_message"
  }'
```

## 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}}, your order #{{order_number}} is ready for pickup at 100 Example Street.</p>",
    "can_create": true,
    "can_delete": true,
    "can_update": true,
    "created_at": "2026-10-01T09:00:00+00:00",
    "id": "DVubREua5aJkwh",
    "internal_attachments": [
      {
        "created_at": "2026-10-01T09:00:00+00:00",
        "detail": "Sales Order/Quote (PDF)",
        "id": "80qLp4P9l2ftvL",
        "media": null,
        "media_id": null,
        "name": "Sales order PDF",
        "options": "[]",
        "order_id": null,
        "order_scoped_id": "",
        "purchase_order_id": null,
        "purchase_order_scoped_id": "",
        "type": "order",
        "updated_at": "2026-10-01T09:00:00+00:00"
      }
    ],
    "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-10-01T09: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.
- `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: `type`, `name` or `body` is missing, the Liquid is invalid, or an inline attachment has a `media_id` (`validation_failed`). Fix: Fix the field named in `error.fields`; add files with the attachment operation.
  - When: An attachment type is not supported (`type_not_supported`), or a `media` or `reference_media` attachment is sent without `media_id` (`media_not_found`). Nothing is saved. Fix: Use a document type from `supported_attachments`; add files with the attachment operation.
  - When: The type is a system type: `error.code` `system_template`. Fix: Edit the existing system template instead.
- `500` A business rule refused the request (see the operation's errors), or something failed inside YoPrint. Refusals use the error envelope with a code such as `action_not_allowed`; an unexpected failure answers `{"message": "Server Error"}`. Repeating a refusal gets the same answer; after an unexpected failure, read the record back before you retry a change.
  - When: `type` is not a known template type. The body is `{"message": "Server Error"}`, without the error envelope. Fix: Use one of the six saved types.

## Related

- [List message template types](https://developer.yoprint.com/reference/message-templates/v2-message-template-config-index.md): `GET /v2/api/store/{team_slug}/setting/message_template/config`
- [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`
- [Add an attachment to a template](https://developer.yoprint.com/reference/message-template-attachments/v2-message-template-internal-attachment-store.md): `POST /v2/api/store/{team_slug}/setting/message_template/{hash_id}/internal_attachment`