Get a message template type

GET/v2/api/store/{team_slug}/setting/message_template/config/{type}

v2Operation ID v2_public_message_template_config_show

Returns one template type, by its type value (for example sales_order_message): its default name, subject and body, placeholders and supported attachments. An unknown type returns 404 template_not_found.

Permission

Any member of the team.

Path parameters

• team_slugstringrequired

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

  • Example your-team
• typestringrequired

  The template type.

  • 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"
  • Example sales_order_message

Request body

This operation takes no request body.

Response

200Successful response.

• dataobjectrequired
  Child fields (12)

  • bodystringrequired

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

  • can_createbooleanrequired
  • can_deletebooleanrequired
  • can_updatebooleanrequired
  • namestringrequired

    The default name of a new template of this type.

  • subjectstring | nullrequired

    The default subject, for the three system types; null for the others.

  • 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"
• 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.

  When

  The type is unknown: error.code template_not_found.

  Fix

  Use a type from the list of template types.

Related

• GETList message template types/v2/api/store/{team_slug}/setting/message_template/config

Example request

curl

curl 'https://secure.yoprint.com/v2/api/store/your-team/setting/message_template/config/sales_order_message' \  -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 Sales Order #{{order_number}} is ready for collection.</p>",
    "can_create": true,
    "can_delete": true,
    "can_update": true,
    "name": "Ready For Collection (Example)",
    "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"
  },
  "status": 200,
  "success": true
}