Get a message template

GET/v2/api/store/{team_slug}/setting/message_template/{hash_id}

v2Operation ID v2_public_message_template_show

Returns one message template with its raw subject and body (placeholders not filled in), its placeholders and its attachments. To see it filled in for a record, compile it.

Permission

Any member of the team, whatever their role. This is wider than the web app, whose Settings pages need Manage Settings: on the API only changes need it.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team
• hash_idstringrequired

  The message template. Its hash id from an earlier answer; there is no unique key for it.

  • Example DVubREua5aJkwh

Request body

This operation takes no request body.

Response

200Successful response.

• dataobjectrequired
  Child fields (16)

  • bodystringrequired

    Liquid: HTML for emails, plain text for text messages.

  • can_createbooleanrequired
  • can_deletebooleanrequired
  • can_updatebooleanrequired
  • created_atstring (date-time)required
  • idstringrequired
  • internal_attachmentsarray of objectsrequired

    Its attachments, as the attachment operations return them.

    Fields of each item (13)

    • created_atstring (date-time)required
    • detailstring | nullrequired

      For a document attachment, defaults to its kind, such as Sales Order/Quote (PDF).

    • idstringrequired
    • mediaobject | nullrequired

      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_idstring | nullrequired
    • namestring | nullrequired
    • optionsstring | nullrequired

      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_idstring | nullrequired
    • order_scoped_idstring | integer | nullrequired
    • purchase_order_idstring | nullrequired
    • purchase_order_scoped_idstring | integer | nullrequired
    • typestringrequired
    • updated_atstring (date-time)required
  • namestringrequired
  • subjectstring | nullrequired

    Liquid, as saved; null when none was saved. Only the three system types use a subject (support_subject: true).

  • support_attachmentsbooleanrequired

    True for every type, text messages included.

  • support_subjectbooleanrequired

    True for the three system types only. The six saved types have no subject line of their own.

  • supported_attachmentsarray of stringsrequired

    The attachment type values this template can carry.

  • supported_placeholderarray of objectsrequired
    Fields of each item (2)

    • labelstringrequired
    • valuestringrequired

      Write it in the template as {{value}}.

  • systembooleanrequired

    A system template: YoPrint's own email for new documents. It can be edited but not created or deleted.

  • typestringrequired
    • 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_atstring (date-time)required
• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You 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.

• 404Not 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.

Related

• PATCHTouch a message template/v2/api/store/{team_slug}/setting/message_template/{hash_id}
• POSTFill in a template for a record/v2/api/store/{team_slug}/setting/message_template/compile

Example request

curl

curl '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'

Example response 200

Response

{
  "data": {
    "body": "<p>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": [],
    "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
}