Fill in a template for a record

POST/v2/api/store/{team_slug}/setting/message_template/compile

v2Operation ID v2_public_message_template_compile

Fills a saved template's placeholders from one record and returns the finished subject and body, with the template's attachments. Use it to show someone the message before sending it. Nothing is sent.

object_id is a sales order or quote for sales order and quote templates, and a purchase order for purchase order templates.

Permission

Any member of the team: with a personal API key, no permission on the record is checked. AI apps need permission to view that record, and its sign-in and file links read as placeholders for them.

Path parameters

• team_slugstringrequired

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

  • Example your-team

Request body

application/json, required.

• idstringrequired

  The saved template's id.

• object_idstringrequired

  The record it is about: a sales order or quote id for sales order and quote templates, a purchase order id for purchase order templates.

Response

200Successful response.

• dataobjectrequired
  Child fields (3)

  • bodystringrequired
  • internal_attachmentsarray of objectsrequired

    The template's attachments, as the attachment operations return them, except that a media attachment reads type: reference_media here.

    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
  • subjectstringrequired

    The filled-in subject. An empty string for types without a subject line (all but the three system types).

• 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

  No template of your team has this id.

  Fix

  Use an id from the template list.

• 422The 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

  object_id is missing (validation_failed).

  Fix

  Send the record's id.

  When

  object_id is not a record of your team of the right kind: error.code compile_failed.

  Fix

  Send a sales order or quote id for those templates, a purchase order id for purchase order templates.

Related

• POSTSend a template for a record/v2/api/store/{team_slug}/setting/message_template/send
• POSTPreview template text/v2/api/store/{team_slug}/setting/message_template/preview

Example request

curl

curl -X POST 'https://secure.yoprint.com/v2/api/store/your-team/setting/message_template/compile' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "id": "DVubREua5aJkwh",    "object_id": "zGZRXNGeh5cs6M"  }'

Example response 200

Response

{
  "data": {
    "body": "<p>Your order #1001 is ready for pickup at 100 Example Street.</p>",
    "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"
      }
    ],
    "subject": ""
  },
  "status": 200,
  "success": true
}