Custom template for PM via API?

Development
,

AI-generated summary

In a discussion titled “Custom template for PM via API?” under the Dev category with tags email and rest-api, BrianGillespie asks whether it’s possible to use a custom template when sending private messages via the Discourse API, noting that the default subject prefix [McNeel Forum] [PM] may confuse non-forum users. He references existing guides and an unanswered thread on the topic. pfaffman replies that while Discourse allows global text customization via Customize text in Discourse, there’s no built-in way to differentiate API-sent messages from front-end ones. BrianGillespie follows up, asking if a plugin already exists for this purpose. pfaffman clarifies that since the API powers the front end, no distinction exists by default — achieving different text would require a custom plugin that either adds a new endpoint or accepts a parameter to modify the subject line. No existing plugin currently fulfills this need.

1

Hi, We’re building a system for reaching out to users when our software crashes, and are thinking of using Discourse as a private email support portal and and Start a new conversation with a customer not yet in Discourse via the API.

When I send the email via the API it seems to use one of the built-in templates and prepends [McNeel Forum] [PM] to the subject. While reasonable for other uses of PMs, I’m concerned that our users who are not on the forum will find this confusing or even spammy.

Is there a way to specify a custom template when sending via the API? I don’t see it here:

There is a similar unanswered question here:

2

You can customize the text of that Customize text in Discourse but not different for api and front end. If you need it different, you’ll need a plugin.

3

Thank you for the reference to customizing the text. Ideally, we’d have different text from the API - is there already a plugin for this? Cheers

4

No. The API is how the front end does all of its work. There is no distinction between the API and the ux.

You would need a plugin that either created a new endpoint or took a parameter to change the subject.