Send an email
POST /api/emails with a Bearer key. Each recipient in to, cc, and bcc counts as one email.
curl -X POST http://localhost:4000/api/emails \ -H "Authorization: Bearer pg_your_key" \ -H "Content-Type: application/json" \ -d '{ "from": "Ada <ada@yourdomain.com>", "to": ["person@example.com"], "subject": "Welcome", "html": "<p>Hello</p>" }'
Password-reset routes can pass filter.transaction_id, a stable id for the person or the request. Pigeon allows 20 messages for that id, and 20 to the same address, inside 10 minutes. The next message for that key is refused for 60 minutes and stays out of the plan. The account owner receives one note that an incident was detected and sending for that key is temporarily stopped. Set filter.admin to true when the recipient is an admin who should keep receiving mail. Messages without a filter keep sending.
Official SDKs wrap this endpoint. The libraries are public under github.com/pigeonfs.
Dashboard templates start as drafts. Each template has a locale. Publish it, then send with template set to its slug and optional variables for {{name}} fields. When the same slug exists in more than one locale, also send locale. Unpublished slugs are rejected. Insert an Unsubscribe link in the template. Pigeon replaces {{unsubscribe}} with a personal link. After someone uses it, that address is left off later mail from the same domain until you subscribe them again on their audience page.
Write and publish a template SDK libraries and highlighted examples Send over SMTP instead