Skip to content
YoPrintDevelopers

Touch a message template

Open .md

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

v2Operation ID v2_public_message_template_update_patch

Use PUT to change a message template. PATCH changes only options, which in practice are not saved. See Update a message template (PUT) for the fields.

Permission

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

Side effects

  • Team members who have YoPrint open see the change at once.

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

application/json, required.

  • bodystring

    Liquid.

  • namestring
  • optionsobject

    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.

    Child fields (3)
  • subjectstring

    Liquid.

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.

    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.

  • 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. error.code is null; error.message names the record type.
    Fix
    Use an id from the 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
    subject or body is not valid Liquid, or a button is enabled without a label and link (validation_failed).
    Fix
    Fix the template text.

AI agents: read /llms.txt; add .md to any page URL for its Markdown. Guides and concepts in one file: /llms-full.txt.

Download the OpenAPI specSupport: support@yoprint.comyoprint.com