docs: Update REST API example

sofn-xyz / mailing

Build, test, send emails with React

https://www.mailing.run

MIT License

3.61k stars 72 forks source link

docs: Update REST API example #431

Closed tinykite closed 1 year ago

tinykite commented 1 year ago

Describe your changes

Updates the documentation for how to use the Mailing REST API to request the compiled html for a template. The current example does not use JSON.stringify to convert a JavaScript value to a JSON string, which will result in an error if someone tries to do a fetch request.

I tested this locally, to make sure the formatting of the code block matches the JavaScript example further down the page for the api/sendMail endpoint.

Screenshot 2023-01-27 at 12 43 49 PM

Issue link

No Github issue for this

Checklist before requesting a review

[x] I have performed a self-review of my code
[ ] If it is a core feature, I have added thorough tests.

changeset-bot[bot] commented 1 year ago

⚠️ No Changeset found

Latest commit: fa827e85b2e4ac313d9c0a3634d17e6350412fd7

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

vercel[bot] commented 1 year ago

@tinykite is attempting to deploy a commit to the sofn Team on Vercel.

A member of the Team first needs to authorize it.

vercel[bot] commented 1 year ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated
mailing-web	✅ Ready (Inspect)	Visit Preview	💬 Add your feedback	Jan 27, 2023 at 7:50PM (UTC)