Added transactional mail api docs
This commit is contained in:
parent
31442453ea
commit
ed4a13fef7
3 changed files with 37 additions and 2 deletions
|
@ -368,6 +368,35 @@ export default class API extends Component {
|
|||
</p>
|
||||
|
||||
<pre>curl -XGET '{getUrl(`api/rss/fetch/5OOnZKrp0?access_token=${accessToken}`)}'</pre>
|
||||
|
||||
<h4>POST /api/templates/:templateId/send – {t('sendTransactionalEmail')}</h4>
|
||||
|
||||
<p>
|
||||
{t('sendSingleEmailByTemplateId')}
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<strong>GET</strong> {t('arguments')}
|
||||
</p>
|
||||
<ul>
|
||||
<li><strong>access_token</strong> – {t('yourPersonalAccessToken')}</li>
|
||||
</ul>
|
||||
|
||||
<p>
|
||||
<strong>POST</strong> {t('arguments')}
|
||||
</p>
|
||||
<ul>
|
||||
<li><strong>EMAIL</strong> – {t('emailAddress')} (<em>{t('required')}</em>)</li>
|
||||
<li><strong>SUBJECT</strong> – {t('subject')}</li>
|
||||
<li><strong>VARIABLES</strong> – {t('templateVariables')}: <em>{"{"} FOO: bar {"}"}</em></li>
|
||||
</ul>
|
||||
|
||||
<p>
|
||||
<strong>{t('example')}</strong>
|
||||
</p>
|
||||
|
||||
<pre>curl -XPOST '{getUrl(`api/templates/1/send?access_token={accessToken}`)}' \
|
||||
--data 'EMAIL=test@example.com&SUBJECT=Test&VARIABLES[FOO]=bar&VARIABLES[TEST]=example'</pre>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
|
|
@ -964,5 +964,8 @@
|
|||
"thePasswordMustContainAtLeastOne": "The password must contain at least one lowercase letter",
|
||||
"thePasswordMustContainAtLeastOne-1": "The password must contain at least one uppercase letter",
|
||||
"thePasswordMustContainAtLeastOneNumber": "The password must contain at least one number",
|
||||
"thePasswordMustContainAtLeastOneSpecial": "The password must contain at least one special character"
|
||||
"thePasswordMustContainAtLeastOneSpecial": "The password must contain at least one special character",
|
||||
"templateVariables": "Map of template variables to replace",
|
||||
"sendTransactionalEmail": "Send transactional email",
|
||||
"sendSingleEmailByTemplateId": "Send single template by :templateId"
|
||||
}
|
|
@ -964,6 +964,9 @@
|
|||
"thePasswordMustContainAtLeastOne": "The password must contain at least one lowercase letter",
|
||||
"thePasswordMustContainAtLeastOne-1": "The password must contain at least one uppercase letter",
|
||||
"thePasswordMustContainAtLeastOneNumber": "The password must contain at least one number",
|
||||
"thePasswordMustContainAtLeastOneSpecial": "The password must contain at least one special character"
|
||||
"thePasswordMustContainAtLeastOneSpecial": "The password must contain at least one special character",
|
||||
"templateVariables": "Map of template variables to replace",
|
||||
"sendTransactionalEmail": "Send transactional email",
|
||||
"sendSingleEmailByTemplateId": "Send single template by :templateId"
|
||||
}
|
||||
|
Loading…
Reference in a new issue