Skip to content

docs(guides): document idempotency_key on transactional sends #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
CosmoBlk wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(guides): document idempotency_key on transactional sends #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion guides/sending-emails.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,13 @@ curl -X POST https://api.nitrosend.com/v1/my/messages \
"to": "user@example.com",
"subject": "Your receipt",
"html": "<h1>Thanks for your purchase</h1>",
"body": "Thanks for your purchase"
"body": "Thanks for your purchase",
"idempotency_key": "receipt-order-1042"
}'
```

Always pass an `idempotency_key` (or an `Idempotency-Key` header): a stable value tied to the triggering event, such as `receipt-order-1042`. Retrying with the same key never sends a duplicate; reusing a key with a different payload returns a `409 idempotency_conflict`. Keyless sends are deprecated and will be rejected from **1 September 2026** (responses already carry `Deprecation` and `Sunset` headers).

## Email editor

The drag-and-drop editor lets you build responsive emails visually. Your brand theme (colors, fonts, logo) is applied automatically. All emails are rendered as MJML under the hood for maximum inbox compatibility.
Expand Down