{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Editing Communicator Templates","siteUrl":"https://docs.peachfinance.com","description":"API and product documentation for Peach Finance, a lending-as-a-service platform.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"editing-communicator-templates","__idx":0},"children":["Editing Communicator Templates"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Communications sent out via Communicator can be edited (content or styling) by changing the appropriate template."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"making-changes-via-api","__idx":1},"children":["Making Changes via API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Templates can be directly editing using the API see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://docs.peachfinance.com/api-docs/api-public/templates/peach.communicator.handlers.update_template_version#templates/peach.communicator.handlers.update_template_version/t=request&in=path&path=templateversionid"},"children":["the Update Template Version endpoint"]}," in the API docs."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"making-changes-via-the-template-editor","__idx":2},"children":["Making Changes via the Template Editor"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can also use the Peach Admin dashboard UI to edit templates. Visit your Admin Dashboard and click the \"Templates\" menu option. Check with ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"mailto:support@peachfinance.com"},"children":["Peach Support"]}," if you don't already have access to the Peach Admin dashboard."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"template-syntax","__idx":3},"children":["Template Syntax"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Peach templates are Jinja templates and so their syntax and semantics are the same. See the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://jinja.palletsprojects.com/en/stable/templates/"},"children":["Jinja Documentation"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"available-variables","__idx":4},"children":["Available Variables"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Different template variables are available depending on type of message being sent. For instance, almost all messages sent via Communicator are related to a borrower, so the variable ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{person}}"]}," is available for use. Other variables, like ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{loan}}"]}," only make sense for messages being sent regarding a specific loan. For instance, a message with subject ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentMethodAdded"]}," has no loan associated with it, and thus no ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{loan}}"]}," variable available for use. Whereas, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["loanPaidOff"]}," ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["does"]}," have a loan associated with it, and so does have ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{loan}}"]}," variable available."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"variable-company","__idx":5},"children":["Variable ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{company}}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This variable is always available. It references the Company object of the company which is sending the message."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Note the important subfield: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{company.config}}"]}," which is the Company Config object which contains important configurations."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Examples"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"...\n\nThanks you,\n- {{company.brandName}}\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"<img alt=\"logo\" src=\"{{company.config.brandAssets.logos.small}}\">\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"variable-person","__idx":6},"children":["Variable ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{person}}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This variable is available for messages sent which are related to a borrower (most messages)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The borrower referenced is the borrower to whom the message is being sent. Note that for historical reasons even borrowers of type \"Business\" are referenced by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{person}}"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Examples"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Dearest {{person.name.firstName}},\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"variable-case","__idx":7},"children":["Variable ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{case}}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This variable is available for messages sent which are related to a case."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The case referenced is the case about which the message is being sent."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"variable-loantypecompanyconfig","__idx":8},"children":["Variable ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{loanTypeCompanyConfig}}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This variable is available for messages sent which are related to a loan. It provides access to company configuration values with support for ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["loan type-specific overrides"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Resolution Order"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When you access an attribute on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["loanTypeCompanyConfig"]},", the value is resolved in this order:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Loan Type Company Config Override"]}," - If the loan has an associated loan type with a company config override, that value is used first."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Company Object Attributes"]}," - Standard company fields like ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["legalName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["brandName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["domainName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shortDomainName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["slug"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Company Config"]}," - Values from the company's config object (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["brandAssets"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["support"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timezone"]},")."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Empty String"]}," - If the attribute is not found anywhere, returns an empty string."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Supported Attributes"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Attribute"},"children":["Attribute"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["legalName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The company's legal name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["brandName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The company's brand name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The company's name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["domainName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The company's domain name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shortDomainName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The company's short domain name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["slug"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The company's slug"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["brandAssets.*"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Brand assets from company config (logos, colors, etc.)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["support.*"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Support contact information from company config"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timezone"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The company's timezone"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["(other config keys)"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Any other keys from the company config"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Examples"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Using brand name with loan type override support:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"html","header":{"controls":{"copy":{}}},"source":"Thank you for choosing {{loanTypeCompanyConfig.brandName}}!\n","lang":"html"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Using support contact information:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"html","header":{"controls":{"copy":{}}},"source":"Questions? Contact us at {{loanTypeCompanyConfig.support.email}} \nor call {{loanTypeCompanyConfig.support.phone}}.\n","lang":"html"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Using brand assets:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"html","header":{"controls":{"copy":{}}},"source":"<img alt=\"logo\" src=\"{{loanTypeCompanyConfig.brandAssets.logos.primary}}\">\n","lang":"html"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," If no loan type override is configured, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{loanTypeCompanyConfig}}"]}," will return the same values as accessing the equivalent fields on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{company}}"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{company.config}}"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":9},"children":["Next steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/communications/bulk-sender"},"children":["Bulk Sender"]}]}," — Run a campaign that sends a templated message to many borrowers at once."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/communications"},"children":["Communications overview"]}]}," — Index of communications channels and tools."]}]}]},"headings":[{"value":"Editing Communicator Templates","id":"editing-communicator-templates","depth":1},{"value":"Making Changes via API","id":"making-changes-via-api","depth":2},{"value":"Making Changes via the Template Editor","id":"making-changes-via-the-template-editor","depth":2},{"value":"Template Syntax","id":"template-syntax","depth":2},{"value":"Available Variables","id":"available-variables","depth":2},{"value":"Variable {{company}}","id":"variable-company","depth":3},{"value":"Variable {{person}}","id":"variable-person","depth":3},{"value":"Variable {{case}}","id":"variable-case","depth":3},{"value":"Variable {{loanTypeCompanyConfig}}","id":"variable-loantypecompanyconfig","depth":3},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"seo":{"title":"Editing Communicator Templates"}},"lastModified":"2026-05-01T14:33:55.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/communications/editing-templates","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}