Message templates

API reference › Team settings

Reusable email and text messages for sales orders, quotes and purchase orders, with placeholders and attachments.

11 operations

• POSTCreate a message template/v2/api/store/{team_slug}/setting/message_templateSaves a new email or text message template for sales orders, quotes or purchase orders.
• GETList message templates/v2/api/store/{team_slug}/setting/message_templateReturns all of the team's message templates: the system ones (the emails YoPrint sends for new sales orders, quotes and purchase orders) and the ones your team saved, with their raw subject and body, placeholders and attachments.
• GETList message template types/v2/api/store/{team_slug}/setting/message_template/configReturns every kind of message template YoPrint supports, with its default name, subject and body, its placeholders and the attachments it can carry.
• GETGet a message template/v2/api/store/{team_slug}/setting/message_template/{hash_id}Returns one message template with its raw subject and body (placeholders not filled in), its placeholders and its attachments.
• GETGet a message template type/v2/api/store/{team_slug}/setting/message_template/config/{type}Returns one template type, by its type value (for example sales_order_message): its default name, subject and body, placeholders and supported attachments.
• POSTPreview template text/v2/api/store/{team_slug}/setting/message_template/previewRenders template text you are writing, before you save it: send the type, body and optional subject.
• PUTUpdate a message template/v2/api/store/{team_slug}/setting/message_template/{hash_id}Changes a template's name, subject, body or button settings.
• PATCHTouch a message template/v2/api/store/{team_slug}/setting/message_template/{hash_id}Use PUT to change a message template.
• POSTFill in a template for a record/v2/api/store/{team_slug}/setting/message_template/compileFills a saved template's placeholders from one record and returns the finished subject and body, with the template's attachments.
• POSTSend a template for a recordSpends money/v2/api/store/{team_slug}/setting/message_template/sendFills a saved template from one record and sends it now.
• DELETEDelete a message template/v2/api/store/{team_slug}/setting/message_template/{hash_id}Deletes one of your saved templates for good.