# Notix docs > Notix is email, SMS and one-time codes for developers and their AI agents: a REST API, SDKs for Node.js, Python and PHP, an SMTP relay, webhooks, and a hosted MCP server. The API base URL is https://app.usenotix.dev/api. Every page below is also in one file at https://usenotix.dev/docs/llms-full.txt. ## Get started - [Introduction](https://usenotix.dev/docs): Notix is email, SMS and one-time codes for developers and their AI agents. Start here to find the right guide. - [Quickstart](https://usenotix.dev/docs/quickstart): Create an API key, verify a domain and send your first email in about two minutes. - [Platform tour](https://usenotix.dev/docs/platform-tour): Every screen of the Notix console, one by one, with a link to the guide for each. - [Create an API key](https://usenotix.dev/docs/create-an-api-key): Make an API key in the console, pick its permission and keep it safe on your server. - [Add and verify a domain](https://usenotix.dev/docs/add-a-domain): Send from your own address, like receipts@acme.com. About 5 minutes, most of it waiting for DNS. - [Connect your AI](https://usenotix.dev/docs/connect-your-ai): Give Claude, ChatGPT or Cursor a key, and set the limits it works within. ## Quickstarts - [Node.js](https://usenotix.dev/docs/quickstarts/nodejs): Send an email from Node.js with the notix-js SDK. - [Next.js](https://usenotix.dev/docs/quickstarts/nextjs): Send an email from a Next.js route handler or server action with notix-js. - [Python](https://usenotix.dev/docs/quickstarts/python): Send an email from Python with the notix-sdk package. - [PHP](https://usenotix.dev/docs/quickstarts/php): Send an email from PHP with the usenotix/notix-php package. - [Laravel](https://usenotix.dev/docs/quickstarts/laravel): Send an email from a Laravel app with the usenotix/notix-php package. - [SMTP](https://usenotix.dev/docs/quickstarts/smtp): Send through the Notix SMTP relay from any app or framework that speaks SMTP. - [cURL](https://usenotix.dev/docs/quickstarts/curl): Send an email with one HTTP request from your terminal. ## Sending - [Send emails](https://usenotix.dev/docs/sending/send-emails): Send one email with the API: from, to, subject and body, plus cc, bcc, reply-to and headers. - [Batch sending](https://usenotix.dev/docs/sending/batch-sending): Send up to 100 different emails in one API call. - [Attachments](https://usenotix.dev/docs/sending/attachments): Attach files to an email, with the size and type limits. - [Schedule email](https://usenotix.dev/docs/sending/schedule-email): Send an email later, then reschedule or cancel it before it goes. - [Idempotency keys](https://usenotix.dev/docs/sending/idempotency-keys): Retry a send safely. The same key and body never send twice. - [Test emails](https://usenotix.dev/docs/sending/test-emails): Send a test copy to your team, or preview a send with a dry run. - [Email logs](https://usenotix.dev/docs/sending/email-logs): Find any email you sent, see its events and why it bounced. - [Metrics](https://usenotix.dev/docs/sending/metrics): Your sending numbers per domain and per day: deliverability, bounces, complaints, opens and clicks. - [Check before you send](https://usenotix.dev/docs/sending/deliverability-check): Run the pre-send check on a message: a score, a verdict and the fix for each finding. - [Bounces and suppressions](https://usenotix.dev/docs/sending/bounces-and-suppressions): Why addresses land on the suppression list, and how to check, add and lift them. - [Sending rules](https://usenotix.dev/docs/sending/sending-rules): Quiet hours, a frequency cap per contact, daily caps and an SMS country allow list. - [Warm-up](https://usenotix.dev/docs/sending/warm-up): Why a new domain starts at 200 emails a day, what counts, and what happens at the limit. - [React Email](https://usenotix.dev/docs/sending/react-email): Render a React Email component to HTML and plain text, then send both with notix-js. ## Receiving - [Receiving emails](https://usenotix.dev/docs/receiving/receiving-emails): Receive mail at a Notix address, read it in the console, by API or by webhook. - [Custom receiving domains](https://usenotix.dev/docs/receiving/custom-receiving-domains): Receive mail at any address on your own domain. Rolling out account by account. - [Shared inbox](https://usenotix.dev/docs/receiving/shared-inbox): Answer received mail as a team: assign, add notes, reply and close conversations. - [Forward received emails](https://usenotix.dev/docs/receiving/forward-received-emails): Forward received mail to confirmed addresses by rules, and read why each message was or was not forwarded. - [Attachments](https://usenotix.dev/docs/receiving/attachments): Read the files that come with received mail, by API or webhook. - [AI agents and untrusted email](https://usenotix.dev/docs/receiving/untrusted-email): How Notix labels replies, contact fields and CSV rows as untrusted text for AI agents. ## Marketing - [Broadcasts](https://usenotix.dev/docs/marketing/broadcasts): Write a broadcast, pick who gets it, review it and send it now or later. - [Automations](https://usenotix.dev/docs/marketing/automations): Build automations that branch: emails, waits, events, If / else, contact updates and segments. Then follow each run. - [Events](https://usenotix.dev/docs/marketing/events): Name the events your app sends, send them by API, and use their data in automation emails. - [Templates and library](https://usenotix.dev/docs/marketing/templates): Start from the starter library, edit in Template Studio, and send a template from the API or a broadcast. - [Contacts and segments](https://usenotix.dev/docs/marketing/contacts-and-segments): Keep contacts in contact books, import a CSV, and build segments to send to part of a list. - [Topics](https://usenotix.dev/docs/marketing/topics): Let contacts choose which kinds of email they get, and send a campaign to one topic. - [Segment rules](https://usenotix.dev/docs/marketing/segment-rules): Build live segments from contact details, properties and email activity. - [Double opt-in](https://usenotix.dev/docs/marketing/double-opt-in): Confirm new subscribers before they get a broadcast. - [Personalisation](https://usenotix.dev/docs/marketing/personalisation): Put each contact's own details in a broadcast, with fallbacks. - [Migrate to Notix](https://usenotix.dev/docs/marketing/move-to-notix): Bring your domains, contacts, templates and webhooks from another provider with the Migration Center. ## SMS and codes - [Send SMS](https://usenotix.dev/docs/sms/send-sms): Send a text message from the API or the console, paid from your wallet. - [Sender IDs](https://usenotix.dev/docs/sms/sender-ids): Which sender ID your messages use, and how to register your own in Nigeria and Kenya. - [One-time codes](https://usenotix.dev/docs/sms/one-time-codes): Send a code by email or SMS, check what the user typed, and tune the risk checks. ## Domains - [Verified domains](https://usenotix.dev/docs/domains/verified-domains): What a verified domain is, the records it needs, and how Notix keeps checking them. - [Open and click tracking](https://usenotix.dev/docs/domains/tracking): Turn open and click tracking on or off for each domain. - [DMARC](https://usenotix.dev/docs/domains/dmarc): Add a DMARC record so mailbox providers trust mail from your domain. - [Domain health and pauses](https://usenotix.dev/docs/domains/health-and-pauses): How Notix watches bounces and complaints, and pauses a domain to protect your reputation. ## Add your DNS records - [Overview](https://usenotix.dev/docs/dns-records): The four records Notix needs, how to find who runs your DNS, and a guide for each DNS host. - [Cloudflare](https://usenotix.dev/docs/dns-records/cloudflare): Step by step: add the Notix DKIM, SPF, MX and DMARC records by hand in the Cloudflare dashboard. - [GoDaddy](https://usenotix.dev/docs/dns-records/godaddy): Step by step: add the Notix DKIM, SPF, MX and DMARC records on your domain's DNS page at GoDaddy. - [Namecheap](https://usenotix.dev/docs/dns-records/namecheap): Step by step: add the Notix DKIM, SPF, MX and DMARC records in Advanced DNS, or in cPanel on Namecheap hosting. - [Name.com](https://usenotix.dev/docs/dns-records/name-com): Step by step: add the Notix DKIM, SPF, MX and DMARC records in the DNS records screen at Name.com. - [Vercel](https://usenotix.dev/docs/dns-records/vercel): Step by step: add the Notix DKIM, SPF, MX and DMARC records for a domain whose DNS is at Vercel. - [Dynadot](https://usenotix.dev/docs/dns-records/dynadot): Step by step: add the Notix DKIM, SPF, MX and DMARC records in the DNS settings of your Dynadot domain. - [Hostinger](https://usenotix.dev/docs/dns-records/hostinger): Step by step: add the Notix DKIM, SPF, MX and DMARC records on Hostinger's DNS records page. - [Spaceship](https://usenotix.dev/docs/dns-records/spaceship): Step by step: add the Notix DKIM, SPF, MX and DMARC records in Spaceship's Advanced DNS. - [IONOS](https://usenotix.dev/docs/dns-records/ionos): Step by step: add the Notix DKIM, SPF, MX and DMARC records in IONOS DNS, 1&1 and Strato domains included. - [Squarespace](https://usenotix.dev/docs/dns-records/squarespace): Step by step: add the Notix DKIM, SPF, MX and DMARC records under Custom Records in Squarespace Domains. - [Porkbun](https://usenotix.dev/docs/dns-records/porkbun): Step by step: add the Notix DKIM, SPF, MX and DMARC records in Porkbun's Manage DNS Records screen. - [Amazon Route 53](https://usenotix.dev/docs/dns-records/route-53): Step by step: add the Notix DKIM, SPF, MX and DMARC records to a Route 53 hosted zone, quoted TXT values included. - [DigitalOcean](https://usenotix.dev/docs/dns-records/digitalocean): Step by step: add the Notix DKIM, SPF, MX and DMARC records under Networking in DigitalOcean. - [WordPress.com](https://usenotix.dev/docs/dns-records/wordpress-com): Step by step: add the Notix DKIM, SPF, MX and DMARC records for a domain whose DNS is at WordPress.com. - [Wix](https://usenotix.dev/docs/dns-records/wix): Step by step: add the Notix DKIM, SPF, MX and DMARC records in the DNS records of your Wix account. - [Whogohost](https://usenotix.dev/docs/dns-records/whogohost): Step by step: add the Notix DKIM, SPF, MX and DMARC records for a domain whose DNS is at Whogohost. - [QServers](https://usenotix.dev/docs/dns-records/qservers): Step by step: add the Notix DKIM, SPF, MX and DMARC records for a domain whose DNS is at QServers. - [Truehost](https://usenotix.dev/docs/dns-records/truehost): Step by step: add the Notix DKIM, SPF, MX and DMARC records for a domain whose DNS is at Truehost. - [Web4Africa](https://usenotix.dev/docs/dns-records/web4africa): Step by step: add the Notix DKIM, SPF, MX and DMARC records for a domain whose DNS is at Web4Africa. - [Afrihost](https://usenotix.dev/docs/dns-records/afrihost): Step by step: add the Notix DKIM, SPF, MX and DMARC records for a domain whose DNS is at Afrihost. - [xneelo](https://usenotix.dev/docs/dns-records/xneelo): Step by step: add the Notix DKIM, SPF, MX and DMARC records in the xneelo control panel. - [Domains.co.za](https://usenotix.dev/docs/dns-records/domains-co-za): Step by step: add the Notix DKIM, SPF, MX and DMARC records for a domain whose DNS is at Domains.co.za. - [Any other DNS host](https://usenotix.dev/docs/dns-records/any-other-host): Add the four Notix records at any DNS host: what goes in each field, and what to watch for. ## Webhooks - [Introduction](https://usenotix.dev/docs/webhooks): Get an HTTP POST at your server when an email is delivered, bounced, opened or received. - [Verify requests](https://usenotix.dev/docs/webhooks/verify-requests): Check the X-Notix-Signature header so you know a webhook came from Notix. - [Retries](https://usenotix.dev/docs/webhooks/retries): How Notix retries a failed webhook call, and when it turns a webhook off. - [Event types](https://usenotix.dev/docs/webhooks/event-types): Every webhook event Notix sends, with the payload of each. ## Account - [Team and roles](https://usenotix.dev/docs/account/team-and-roles): Invite teammates, choose their role, and see what each role can do. - [API keys and permissions](https://usenotix.dev/docs/account/api-keys): Key permissions, domain limits, send limits, approvals and the audit log. - [API logs](https://usenotix.dev/docs/account/api-logs): See every request your API keys and AI tools made in the last 30 days, and why one failed. - [Plans and units](https://usenotix.dev/docs/account/plans-and-units): Free, Pro, Scale and Business, what a unit is, and what happens at your limit. - [Pay-as-you-go](https://usenotix.dev/docs/account/pay-as-you-go): Keep sending past your units: the price, how it is billed, and how a team admin turns it on. - [Billing and wallet](https://usenotix.dev/docs/account/billing-and-wallet): Plans, the wallet, top-ups, paying for Pro from the wallet, and receipts. - [Spend and limits](https://usenotix.dev/docs/account/spend-and-limits): Monthly budgets per channel, spend alerts and a daily spend limit per API key. - [Referrals and affiliates](https://usenotix.dev/docs/account/referrals-and-affiliates): Refer a team to Notix, or join the affiliate programme and earn a share of what they pay. - [Integrations](https://usenotix.dev/docs/account/integrations): Connect Notix to other apps, and what is coming next. - [Settings](https://usenotix.dev/docs/account/settings): Team settings, connected apps and the one-time code risk rules. ## More - [AI agents](https://usenotix.dev/docs/ai-agents): Everything for building with an AI agent: Connect your AI, the MCP server, llms.txt and untrusted email. - [Knowledge base](https://usenotix.dev/docs/knowledge-base): Short answers on email deliverability, DNS records and sending, from the Notix learn articles. ## API reference - [Introduction](https://usenotix.dev/docs/reference): The Notix REST API: base URL, keys, the OpenAPI document, and every endpoint by area. - [Authentication](https://usenotix.dev/docs/reference/authentication): Send your API key as a Bearer token. What each key permission reaches, and the rules for AI keys. - [Rate limits](https://usenotix.dev/docs/reference/rate-limits): The per second request limit, the rate limit headers, and the recipients per minute budget for sends. - [Errors](https://usenotix.dev/docs/reference/errors): The error envelope, every error code the API returns, and what each one means. - [Idempotency](https://usenotix.dev/docs/reference/idempotency): Send an Idempotency-Key header so a retried request never sends twice. - [Pagination](https://usenotix.dev/docs/reference/pagination): How list endpoints split long results into pages, and how to read the next one. ## API reference: Auth - [Auth API](https://usenotix.dev/docs/reference/auth): Check which team, permission and limits an API key has, and read what the team's keys did. - [Check an API key](https://usenotix.dev/docs/reference/auth/check-an-api-key): Returns the team and the permission of the key in the Authorization header. (`GET /v1/auth/check`) - [Check the connection](https://usenotix.dev/docs/reference/auth/check-the-connection): The health check an AI agent calls first (the notix_ping tool). (`GET /v1/ping`) - [Read this key's limits](https://usenotix.dev/docs/reference/auth/read-this-key-s-limits): The calling key's permission, domain pin, approval policy, request rate limits, and its daily and monthly caps with how much is used and when each resets… (`GET /v1/auth/limits`) - [Read the audit log](https://usenotix.dev/docs/reference/auth/read-the-audit-log): What the team's API keys and AI agents did, newest first: each call's surface (REST or MCP), tool, decision (allowed, dry run, replay or denied), refusal… (`GET /v1/audit-log`) ## API reference: Emails - [Emails API](https://usenotix.dev/docs/reference/emails): Send one email or a batch, read them back, and change or cancel a scheduled send. - [Send an email](https://usenotix.dev/docs/reference/emails/send-an-email): Send one transactional email. (`POST /v1/emails`) - [Send a batch of emails](https://usenotix.dev/docs/reference/emails/send-a-batch-of-emails): Send up to 100 emails in one request. (`POST /v1/emails/batch`) - [Get an email](https://usenotix.dev/docs/reference/emails/get-an-email): Retrieve one email with its latest status. (`GET /v1/emails/{emailId}`) - [List emails](https://usenotix.dev/docs/reference/emails/list-emails): List the team's emails, newest first, filtered and paged by the query parameters. (`GET /v1/emails`) - [Reschedule an email](https://usenotix.dev/docs/reference/emails/reschedule-an-email): Change scheduledAt on an email that has not been sent yet. (`PATCH /v1/emails/{emailId}`) - [Cancel a scheduled email](https://usenotix.dev/docs/reference/emails/cancel-a-scheduled-email): Cancel an email that is scheduled and has not been sent yet. (`POST /v1/emails/{emailId}/cancel`) - [Resend an email](https://usenotix.dev/docs/reference/emails/resend-an-email): Send an email again to the same recipients, as a new email with its own id; the original is not changed. (`POST /v1/emails/{emailId}/resend`) ## API reference: Templates - [Templates API](https://usenotix.dev/docs/reference/templates): Create and manage reusable email bodies, duplicate them, start from the starter library, and send with one by passing its id. - [List templates](https://usenotix.dev/docs/reference/templates/list-templates): List this team's templates, most recently changed first. (`GET /v1/templates`) - [Create a template](https://usenotix.dev/docs/reference/templates/create-a-template): Create a template from an editor document (content) or from finished HTML (html) - one or the other, not both. (`POST /v1/templates`) - [Retrieve a template](https://usenotix.dev/docs/reference/templates/retrieve-a-template): Read one template by id. (`GET /v1/templates/{templateId}`) - [Update a template](https://usenotix.dev/docs/reference/templates/update-a-template): Change a template. (`PATCH /v1/templates/{templateId}`) - [Delete a template](https://usenotix.dev/docs/reference/templates/delete-a-template): Delete a template. (`DELETE /v1/templates/{templateId}`) - [List the starter library](https://usenotix.dev/docs/reference/templates/list-the-starter-library): The starter template library the Templates screen offers: ready-made emails across 14 industries, written by Notix. (`GET /v1/templates/library`) - [Use a starter library template](https://usenotix.dev/docs/reference/templates/use-a-starter-library-template): Copy a starter library entry into your templates, as the library screen's Use button does: the entry is put in your brand (your team name, brand colour… (`POST /v1/templates/from-library`) - [Duplicate a template](https://usenotix.dev/docs/reference/templates/duplicate-a-template): Copy one of your templates, as the Templates screen's Duplicate does: the same subject, preview line, body (editor document and HTML), type and library… (`POST /v1/templates/{templateId}/duplicate`) ## API reference: Domains - [Domains API](https://usenotix.dev/docs/reference/domains): Add a sending domain, read its DNS records, verify it, change its tracking, and ask for a review when it is paused. - [List domains](https://usenotix.dev/docs/reference/domains/list-domains): List the sending domains the API key can use. (`GET /v1/domains`) - [Add a domain](https://usenotix.dev/docs/reference/domains/add-a-domain): Add a sending domain. (`POST /v1/domains`) - [Get a domain](https://usenotix.dev/docs/reference/domains/get-a-domain): Retrieve one domain with its DNS records and verification status. (`GET /v1/domains/{id}`) - [Verify a domain](https://usenotix.dev/docs/reference/domains/verify-a-domain): Start a fresh check of the domain's DNS records. (`PUT /v1/domains/{id}/verify`) - [Delete a domain](https://usenotix.dev/docs/reference/domains/delete-a-domain): Remove a sending domain. (`DELETE /v1/domains/{id}`) - [Get a domain's sending status](https://usenotix.dev/docs/reference/domains/get-a-domain-s-sending-status): Whether the domain can send right now (canSend) and every reason it cannot (blockers): not verified, a DNS record missing (with the exact record to add),… (`GET /v1/domains/{id}/status`) - [Change a domain's settings](https://usenotix.dev/docs/reference/domains/change-a-domain-s-settings): Turn click tracking and open tracking on or off for one domain, as the Tracking card on the domain's page does. (`PATCH /v1/domains/{id}`) - [Request a review of a paused domain](https://usenotix.dev/docs/reference/domains/request-a-review-of-a-paused-domain): Ask Notix to review a domain that was paused for its sending reputation (hard bounces or complaints over the limit), as the domain card's Request review… (`POST /v1/domains/{id}/review`) - [Read a domain's higher-start request](https://usenotix.dev/docs/reference/domains/read-a-domain-s-higher-start-request): Where the domain's latest "Request a higher start" stands, and whether it can ask now. (`GET /v1/domains/{id}/start-request`) - [Request a higher start](https://usenotix.dev/docs/reference/domains/request-a-higher-start): Ask Notix to let a domain start above the automatic 2,000 emails a day, as the "Request a higher start" button on the domain page and the switch-over… (`POST /v1/domains/{id}/start-request`) ## API reference: Contact books - [Contact books API](https://usenotix.dev/docs/reference/contact-books): Create and manage the lists contacts live in. - [List contact books](https://usenotix.dev/docs/reference/contact-books/list-contact-books): List the contact books the API key can reach. (`GET /v1/contactBooks`) - [Create a contact book](https://usenotix.dev/docs/reference/contact-books/create-a-contact-book): Create a new contact book. (`POST /v1/contactBooks`) - [Get a contact book](https://usenotix.dev/docs/reference/contact-books/get-a-contact-book): Retrieve one contact book. (`GET /v1/contactBooks/{contactBookId}`) - [Update a contact book](https://usenotix.dev/docs/reference/contact-books/update-a-contact-book): Change a contact book's details. (`PATCH /v1/contactBooks/{contactBookId}`) - [Delete a contact book](https://usenotix.dev/docs/reference/contact-books/delete-a-contact-book): Delete a contact book and every contact in it. (`DELETE /v1/contactBooks/{contactBookId}`) ## API reference: Contacts - [Contacts API](https://usenotix.dev/docs/reference/contacts): Add, update, upsert and remove contacts, one at a time or up to 1,000 at once. - [List contacts](https://usenotix.dev/docs/reference/contacts/list-contacts): List the contacts in a contact book, paged by the query parameters. (`GET /v1/contactBooks/{contactBookId}/contacts`) - [Add a contact](https://usenotix.dev/docs/reference/contacts/add-a-contact): Add one contact to a contact book. (`POST /v1/contactBooks/{contactBookId}/contacts`) - [Get a contact](https://usenotix.dev/docs/reference/contacts/get-a-contact): Retrieve one contact. (`GET /v1/contactBooks/{contactBookId}/contacts/{contactId}`) - [Update a contact](https://usenotix.dev/docs/reference/contacts/update-a-contact): Change the fields you send on an existing contact. (`PATCH /v1/contactBooks/{contactBookId}/contacts/{contactId}`) - [Upsert a contact](https://usenotix.dev/docs/reference/contacts/upsert-a-contact): Create the contact if it does not exist, or update it if it does. (`PUT /v1/contactBooks/{contactBookId}/contacts/{contactId}`) - [Delete a contact](https://usenotix.dev/docs/reference/contacts/delete-a-contact): Remove one contact from a contact book. (`DELETE /v1/contactBooks/{contactBookId}/contacts/{contactId}`) - [Add contacts in bulk](https://usenotix.dev/docs/reference/contacts/add-contacts-in-bulk): Add up to 1,000 contacts to a contact book in one request. (`POST /v1/contactBooks/{contactBookId}/contacts/bulk`) - [Delete contacts in bulk](https://usenotix.dev/docs/reference/contacts/delete-contacts-in-bulk): Remove up to 1,000 contacts from a contact book in one request. (`DELETE /v1/contactBooks/{contactBookId}/contacts/bulk`) - [List suppressed addresses](https://usenotix.dev/docs/reference/contacts/list-suppressed-addresses): Page through the team's suppression list, newest first: the addresses Notix will not send to, with the reason (HARD_BOUNCE, COMPLAINT, MANUAL or… (`GET /v1/suppressions`) - [Check addresses against the suppression list](https://usenotix.dev/docs/reference/contacts/check-addresses-against-the-suppression-list): For up to 100 comma-separated addresses, whether each is on the suppression list, why, and for a SOFT_BOUNCE_REPEATED entry when it lifts (expiresAt). (`GET /v1/suppressions/check`) - [Get suppression and unsubscribe trends](https://usenotix.dev/docs/reference/contacts/get-suppression-and-unsubscribe-trends): How the suppression list grew over the last 30 UTC days, the same figures as the Suppressions page: addresses added each day by reason, people who… (`GET /v1/suppressions/trends`) - [Suppress addresses](https://usenotix.dev/docs/reference/contacts/suppress-addresses): Add up to 100 addresses to the team's suppression list as MANUAL entries. (`POST /v1/suppressions`) - [Lift a manual suppression](https://usenotix.dev/docs/reference/contacts/lift-a-manual-suppression): Remove an address this API key suppressed, or a SOFT_BOUNCE_REPEATED entry. (`DELETE /v1/suppressions/{email}`) - [Import contacts from CSV](https://usenotix.dev/docs/reference/contacts/import-contacts-from-csv): Import up to 1,000 contacts from CSV text (at most 1,000,000 bytes) into a contact book. (`POST /v1/contactBooks/{contactBookId}/contacts/import`) ## API reference: Segments - [Segments API](https://usenotix.dev/docs/reference/segments): Save a live filter on a contact book and read who matches it. - [List segments](https://usenotix.dev/docs/reference/segments/list-segments): List a contact book's segments, oldest first. (`GET /v1/contactBooks/{contactBookId}/segments`) - [Create a segment](https://usenotix.dev/docs/reference/segments/create-a-segment): Create a live filter on a contact book. (`POST /v1/contactBooks/{contactBookId}/segments`) - [Get a segment](https://usenotix.dev/docs/reference/segments/get-a-segment): Retrieve one segment with its definition, live count and problems. (`GET /v1/contactBooks/{contactBookId}/segments/{segmentId}`) - [Update a segment](https://usenotix.dev/docs/reference/segments/update-a-segment): Change a segment's name, description or definition. (`PATCH /v1/contactBooks/{contactBookId}/segments/{segmentId}`) - [Delete a segment](https://usenotix.dev/docs/reference/segments/delete-a-segment): Delete a segment. (`DELETE /v1/contactBooks/{contactBookId}/segments/{segmentId}`) - [List a segment's contacts](https://usenotix.dev/docs/reference/segments/list-a-segment-s-contacts): Page through the contacts that match a segment right now, ordered by id. (`GET /v1/contactBooks/{contactBookId}/segments/{segmentId}/contacts`) - [Preview a segment](https://usenotix.dev/docs/reference/segments/preview-a-segment): The live count for a segment definition without saving it: how many contacts match now, how many of those are subscribed (who a campaign would reach),… (`POST /v1/contactBooks/{contactBookId}/segments/preview`) - [Export a segment as CSV](https://usenotix.dev/docs/reference/segments/export-a-segment-as-csv): The contacts matching a segment as CSV text, newest first, with the contact book's properties as columns. (`GET /v1/contactBooks/{contactBookId}/segments/{segmentId}/export`) ## API reference: Topics - [Topics API](https://usenotix.dev/docs/reference/topics): Create the kinds of email contacts can choose to get, and read or set each contact's choices. - [List topics](https://usenotix.dev/docs/reference/topics/list-topics): Every topic of the team, newest first, with how many contacts chose to get it (optedIn) and not to (optedOut). (`GET /v1/topics`) - [Create a topic](https://usenotix.dev/docs/reference/topics/create-a-topic): Create a kind of email your contacts can choose to get, like "Product updates". (`POST /v1/topics`) - [Read a topic](https://usenotix.dev/docs/reference/topics/read-a-topic): One topic, with how many contacts chose each way. (`GET /v1/topics/{topicId}`) - [Change a topic](https://usenotix.dev/docs/reference/topics/change-a-topic): Change a topic's name, description or visibility. (`PATCH /v1/topics/{topicId}`) - [Delete a topic](https://usenotix.dev/docs/reference/topics/delete-a-topic): Delete a topic. (`DELETE /v1/topics/{topicId}`) - [Read a contact's topics](https://usenotix.dev/docs/reference/topics/read-a-contact-s-topics): Every topic of the team and where the contact stands on each: subscribed is whether a campaign that targets the topic sends to them, and chosen is false… (`GET /v1/contacts/{contactId}/topics`) - [Set a contact's topics](https://usenotix.dev/docs/reference/topics/set-a-contact-s-topics): Record the contact's choices, up to 50 topics at once. (`PATCH /v1/contacts/{contactId}/topics`) ## API reference: Inbound - [Inbound API](https://usenotix.dev/docs/reference/inbound): Read the email your inboxes receive, and work the shared inbox: reply, assign, set status, leave notes and act on unsubscribe requests. - [List received messages](https://usenotix.dev/docs/reference/inbound/list-received-messages): List the messages your inboxes received, newest first. (`GET /v1/inbound/messages`) - [Get a received message](https://usenotix.dev/docs/reference/inbound/get-a-received-message): Read one received message with its text, sanitized HTML, the new part without quoted history (strippedText) and attachment links that work for 15 minutes. (`GET /v1/inbound/messages/{id}`) - [Download the original message](https://usenotix.dev/docs/reference/inbound/download-the-original-message): Download the original message exactly as it arrived, as an .eml file. (`GET /v1/inbound/messages/{id}/raw`) - [List a message's attachments](https://usenotix.dev/docs/reference/inbound/list-a-message-s-attachments): List the files attached to one received message: id, file name, the type the sender gave, size, and the content id of inline images. (`GET /v1/inbound/messages/{id}/attachments`) - [Download an attachment](https://usenotix.dev/docs/reference/inbound/download-an-attachment): Download one attachment. (`GET /v1/inbound/messages/{id}/attachments/{attachmentId}`) - [Get a download link for an attachment](https://usenotix.dev/docs/reference/inbound/get-a-download-link-for-an-attachment): The attachment's details and a link that downloads it, valid for 5 minutes. (`GET /v1/inbound/messages/{id}/attachments/{attachmentId}/link`) - [Get a reply thread](https://usenotix.dev/docs/reference/inbound/get-a-reply-thread): Read a whole conversation, oldest message first: every message the customer sent and every reply the team sent, with the Notix email the first message… (`GET /v1/inbound/conversations/{id}`) - [Summarise received mail](https://usenotix.dev/docs/reference/inbound/summarise-received-mail): Counts of what your inboxes received over the last days (7 by default, at most 90): messages, unverified senders, automatic replies and messages that… (`GET /v1/inbound/summary`) - [List conversations](https://usenotix.dev/docs/reference/inbound/list-conversations): The shared inbox's conversations, as its tabs show them. (`GET /v1/inbound/conversations`) - [List a conversation's notes](https://usenotix.dev/docs/reference/inbound/list-a-conversation-s-notes): The internal notes the team left on a conversation, oldest first (the latest 200). (`GET /v1/inbound/conversations/{id}/notes`) - [Add a note](https://usenotix.dev/docs/reference/inbound/add-a-note): Leave an internal note on a conversation, up to 5,000 characters. (`POST /v1/inbound/conversations/{id}/notes`) - [Reply to a conversation](https://usenotix.dev/docs/reference/inbound/reply-to-a-conversation): Send a reply to the customer, in the same thread in their mail app, exactly as the inbox's Reply does: from the inbox's name at your verified sending… (`POST /v1/inbound/conversations/{id}/reply`) - [Assign a conversation](https://usenotix.dev/docs/reference/inbound/assign-a-conversation): Assign a conversation to someone who works in its inbox (a userId from GET /v1/inbound/inboxes/{inboxId}/members), or pass null to unassign it. (`POST /v1/inbound/conversations/{id}/assign`) - [Set a conversation's status](https://usenotix.dev/docs/reference/inbound/set-a-conversation-s-status): Mark a conversation OPEN, PENDING (answered, waiting for the customer) or CLOSED. (`POST /v1/inbound/conversations/{id}/status`) - [Mark a conversation read](https://usenotix.dev/docs/reference/inbound/mark-a-conversation-read): Mark a conversation read for the key's creator. (`POST /v1/inbound/conversations/{id}/read`) - [Mark a conversation unread](https://usenotix.dev/docs/reference/inbound/mark-a-conversation-unread): Mark a conversation unread again for the key's creator, until they next open it. (`POST /v1/inbound/conversations/{id}/unread`) - [Unsubscribe the sender](https://usenotix.dev/docs/reference/inbound/unsubscribe-the-sender): Act on an unsubscribe request, as the inbox's Unsubscribe button does: the contact the conversation is linked to, who replied to a campaign asking to… (`POST /v1/inbound/conversations/{id}/unsubscribe`) - [List an inbox's members](https://usenotix.dev/docs/reference/inbound/list-an-inbox-s-members): The people a conversation in this inbox can be assigned to or mention: the inbox's members and the team's admins, with the handle to write after @ in a… (`GET /v1/inbound/inboxes/{inboxId}/members`) - [Get the inbox status](https://usenotix.dev/docs/reference/inbound/get-the-inbox-status): Whether receiving email is set up (configured), the inboxes the key's creator can see with their addresses and open conversations, and the counts behind… (`GET /v1/inbound/status`) ## API reference: Forwarding - [Forwarding API](https://usenotix.dev/docs/reference/forwarding): Forward the email your inboxes receive to confirmed addresses or a webhook, with rules, a pattern tester and a forward log. - [List forwarding rules](https://usenotix.dev/docs/reference/forwarding/list-forwarding-rules): Every forwarding rule of the team, in the order they are tried, with its addresses and whether each is confirmed. (`GET /v1/forwarding-rules`) - [Create a forwarding rule](https://usenotix.dev/docs/reference/forwarding/create-a-forwarding-rule): Forward email received at matching addresses to confirmed forwarding addresses, a webhook, or both. (`POST /v1/forwarding-rules`) - [Test an address against your rules](https://usenotix.dev/docs/reference/forwarding/test-an-address-against-your-rules): Shows which rule takes a message sent to an address, whether it is forwarded (forwards; a paused rule takes the message and forwards nothing), and every… (`POST /v1/forwarding-rules/test`) - [Get a forwarding rule](https://usenotix.dev/docs/reference/forwarding/get-a-forwarding-rule): One rule, with paused and pauseReason: BREAKER (too many forwards in 10 minutes), REPUTATION (bounces or complaints on the team's forwards), KEY_REVOKED… (`GET /v1/forwarding-rules/{id}`) - [Change a forwarding rule](https://usenotix.dev/docs/reference/forwarding/change-a-forwarding-rule): Change any field of a rule. (`PATCH /v1/forwarding-rules/{id}`) - [Delete a forwarding rule](https://usenotix.dev/docs/reference/forwarding/delete-a-forwarding-rule): Delete a rule. (`DELETE /v1/forwarding-rules/{id}`) - [Read a rule's forward log](https://usenotix.dev/docs/reference/forwarding/read-a-rule-s-forward-log): One row per message and address: SENT with the emailId of the forward (read it with GET /v1/emails/{id}), SKIPPED or FAILED with the reason. (`GET /v1/forwarding-rules/{id}/log`) - [List forwarding addresses](https://usenotix.dev/docs/reference/forwarding/list-forwarding-addresses): Every forwarding address of the team, newest first, with status PENDING or VERIFIED. (`GET /v1/forwarding-destinations`) - [Add a forwarding address](https://usenotix.dev/docs/reference/forwarding/add-a-forwarding-address): Add an address to forward to. (`POST /v1/forwarding-destinations`) - [Remove a forwarding address](https://usenotix.dev/docs/reference/forwarding/remove-a-forwarding-address): Remove an address. (`DELETE /v1/forwarding-destinations/{id}`) ## API reference: Broadcasts - [Broadcasts API](https://usenotix.dev/docs/reference/broadcasts): Create, change, copy, review, preview, schedule, pause and resume broadcasts (formerly campaigns; /v1/campaigns still works). - [Create a broadcast](https://usenotix.dev/docs/reference/broadcasts/create-a-broadcast): Create a broadcast. (`POST /v1/broadcasts`) - [List broadcasts](https://usenotix.dev/docs/reference/broadcasts/list-broadcasts): List the team's broadcasts, paged, and optionally filtered by status (DRAFT, PENDING_REVIEW, SCHEDULED, RUNNING, PAUSED, SENT, CANCELED or FAILED), by… (`GET /v1/broadcasts`) - [Get a broadcast](https://usenotix.dev/docs/reference/broadcasts/get-a-broadcast): Retrieve one broadcast. (`GET /v1/broadcasts/{broadcastId}`) - [Delete a broadcast](https://usenotix.dev/docs/reference/broadcasts/delete-a-broadcast): Delete a broadcast. (`DELETE /v1/broadcasts/{broadcastId}`) - [Schedule a broadcast](https://usenotix.dev/docs/reference/broadcasts/schedule-a-broadcast): Schedule a broadcast to send at a time, or now. (`POST /v1/broadcasts/{broadcastId}/schedule`) - [Approve a broadcast with the emailed code](https://usenotix.dev/docs/reference/broadcasts/approve-a-broadcast-with-the-emailed-code): Approve a broadcast the key's approval policy held, with the 6-digit code emailed to the key's owner and the team's admins. (`POST /v1/broadcasts/{broadcastId}/approve`) - [Pause a broadcast](https://usenotix.dev/docs/reference/broadcasts/pause-a-broadcast): Stop a sending broadcast. (`POST /v1/broadcasts/{broadcastId}/pause`) - [Resume a broadcast](https://usenotix.dev/docs/reference/broadcasts/resume-a-broadcast): Continue a paused broadcast. (`POST /v1/broadcasts/{broadcastId}/resume`) - [Get a broadcast report](https://usenotix.dev/docs/reference/broadcasts/get-a-broadcast-report): The broadcast's results: the same delivered, opened, clicked and unsubscribed figures the broadcast page shows, plus bounces, spam complaints and the… (`GET /v1/broadcasts/{broadcastId}/report`) - [List imported broadcast history](https://usenotix.dev/docs/reference/broadcasts/list-imported-broadcast-history): The sent broadcasts the Migration Center brought over from another provider (Resend, SendGrid or Mailchimp), as read-only history: name, subject, when it… (`GET /v1/broadcasts/imported`) - [Export broadcasts as CSV](https://usenotix.dev/docs/reference/broadcasts/export-broadcasts-as-csv): The Broadcasts list as a spreadsheet, newest first, with the list's filters (status, search, contactBookId): id, name, subject, sender, status, audience,… (`GET /v1/broadcasts/export`) - [Cancel a broadcast](https://usenotix.dev/docs/reference/broadcasts/cancel-a-broadcast): Cancel a scheduled, sending or paused broadcast, as Cancel does on the dashboard. (`POST /v1/broadcasts/{broadcastId}/cancel`) - [List a broadcast's link clicks](https://usenotix.dev/docs/reference/broadcasts/list-a-broadcast-s-link-clicks): Clicks per link in a sent broadcast, most clicked first: every click (clicks) and how many people clicked it (people). (`GET /v1/broadcasts/{broadcastId}/links`) - [List who opened, clicked, bounced or unsubscribed](https://usenotix.dev/docs/reference/broadcasts/list-who-opened-clicked-bounced-or-unsubscribed): How many people opened, clicked, bounced and unsubscribed (counts), and the first people who did one of them (event, opened by default), earliest first,… (`GET /v1/broadcasts/{broadcastId}/activity`) - [Export a broadcast's recipients as CSV](https://usenotix.dev/docs/reference/broadcasts/export-a-broadcast-s-recipients-as-csv): One row per email the broadcast made, at most 5,000: address, first and last name, delivery status, and whether they opened, clicked or unsubscribed. (`GET /v1/broadcasts/{broadcastId}/activity/export`) - [Change a draft broadcast](https://usenotix.dev/docs/reference/broadcasts/change-a-draft-broadcast): Change a draft broadcast's name, sender, subject, preview text, body, audience (contactBookId, segmentId), reply-to, cc or bcc. (`PATCH /v1/broadcasts/{broadcastId}`) - [Create a broadcast from a template](https://usenotix.dev/docs/reference/broadcasts/create-a-broadcast-from-a-template): Create a DRAFT broadcast with its own copy of a template's subject, preview text and body: changing the template later never changes the broadcast, and… (`POST /v1/broadcasts/from-template`) - [Copy a template into a draft broadcast](https://usenotix.dev/docs/reference/broadcasts/copy-a-template-into-a-draft-broadcast): Replace a draft broadcast's subject, preview text and body with its own copy of a template, as "Choose another template" does on the dashboard. (`POST /v1/broadcasts/{broadcastId}/template`) - [Review a broadcast before sending](https://usenotix.dev/docs/reference/broadcasts/review-a-broadcast-before-sending): The dashboard's pre-send review: who it reaches, the sender's domain, the subject, the deliverability check, the unsubscribe link, contacts missing a… (`GET /v1/broadcasts/{broadcastId}/review`) - [Preview a broadcast](https://usenotix.dev/docs/reference/broadcasts/preview-a-broadcast): The broadcast rendered through the renderer a send uses, for one contact of its contact book (contactId; a key limited to one domain answers 403… (`GET /v1/broadcasts/{broadcastId}/preview`) - [List a broadcast's recipients](https://usenotix.dev/docs/reference/broadcasts/list-a-broadcast-s-recipients): Who the broadcast goes to, in the order it sends: a book broadcast's subscribed contacts, or a segment broadcast's subscribed matches (live until the… (`GET /v1/broadcasts/{broadcastId}/recipients`) - [Read the team's welcome send](https://usenotix.dev/docs/reference/broadcasts/read-the-team-s-welcome-send): The free welcome send a team gets when it migrates more than 2,000 contacts by connecting Resend, SendGrid or Mailchimp: one broadcast to its whole… (`GET /v1/welcome-send`) - [Copy a broadcast](https://usenotix.dev/docs/reference/broadcasts/copy-a-broadcast): Create a new DRAFT with the same sender, subject, body and audience as an existing broadcast. (`POST /v1/broadcasts/{broadcastId}/duplicate`) ## API reference: One-time codes - [One-time codes API](https://usenotix.dev/docs/reference/verification): Send a one-time code by email or SMS, with risk scoring, check what the user typed, and list the codes and their figures. - [Send a one-time code](https://usenotix.dev/docs/reference/verification/send-a-one-time-code): Create a one-time code and send it by email or SMS. (`POST /v1/verify/send`) - [Check a one-time code](https://usenotix.dev/docs/reference/verification/check-a-one-time-code): Check the code a user typed against a verification. (`POST /v1/verify/check`) - [Get a verification](https://usenotix.dev/docs/reference/verification/get-a-verification): Retrieve the current state of a verification without changing it. (`GET /v1/verify/{id}`) - [List one-time codes](https://usenotix.dev/docs/reference/verification/list-one-time-codes): The team's one-time codes, newest first, as the One-time codes page lists them: who each went to, by which channel, its status, when it was made and… (`GET /v1/verify`) - [Get one-time code figures](https://usenotix.dev/docs/reference/verification/get-one-time-code-figures): What became of the codes made over range (24h, 7d, 30d or 90d; 7d by default), optionally for one channel: sent, verified, expired (including pending… (`GET /v1/verify/stats`) ## API reference: SMS - [SMS API](https://usenotix.dev/docs/reference/sms): Send a transactional SMS from your wallet, read its delivery status, the SMS overview and figures, and set the one-time code template. - [Send an SMS](https://usenotix.dev/docs/reference/sms/send-an-sms): Send one transactional SMS. (`POST /v1/sms`) - [List SMS messages](https://usenotix.dev/docs/reference/sms/list-sms-messages): List the team's SMS messages, newest first, with a cursor for the next page. (`GET /v1/sms`) - [Get an SMS message](https://usenotix.dev/docs/reference/sms/get-an-sms-message): Retrieve one SMS message by id, with its current delivery status and reason. (`GET /v1/sms/{id}`) - [Get the wallet balance](https://usenotix.dev/docs/reference/sms/get-the-wallet-balance): The team's wallet balance, which SMS and SMS one-time codes are paid from, in minor units and as a decimal string. (`GET /v1/wallet`) - [Get the SMS overview](https://usenotix.dev/docs/reference/sms/get-the-sms-overview): What the SMS page shows: whether SMS is switched on, the sender ID texts to the signup country go out as, the team's sender ID requests and the paperwork… (`GET /v1/sms/overview`) - [Get SMS figures](https://usenotix.dev/docs/reference/sms/get-sms-figures): The team's texts over range (24h, 7d, 30d or 90d; 7d by default), counted as the SMS page counts them, test sends left out: sent (accepted for sending),… (`GET /v1/sms/stats`) - [Get the code template](https://usenotix.dev/docs/reference/sms/get-the-code-template): The text SMS one-time codes are sent with: template is the one in use, custom the team's own (null while the default is used). (`GET /v1/sms/template`) - [Change the code template](https://usenotix.dev/docs/reference/sms/change-the-code-template): Set the team's own template for SMS one-time codes, or send null to go back to the default. (`PUT /v1/sms/template`) ## API reference: Automations - [Automations API](https://usenotix.dev/docs/reference/automations): Build, check, start, stop, copy, import and archive automations, read their runs and metrics, and enrol contacts (formerly journeys). - [List automations](https://usenotix.dev/docs/reference/automations/list-automations): List the automations belonging to the calling team, newest first. (`GET /v1/automations`) - [Get an automation](https://usenotix.dev/docs/reference/automations/get-an-automation): Retrieve one automation and its stats. (`GET /v1/automations/{id}`) - [Enrol a contact](https://usenotix.dev/docs/reference/automations/enrol-a-contact): Enrol a contact into an automation, by contactId or by email within the automation's contact book. (`POST /v1/automations/{id}/enroll`) - [Create an automation](https://usenotix.dev/docs/reference/automations/create-an-automation): Create a DRAFT automation, with its steps if you have them. (`POST /v1/automations`) - [Create an automation from a recipe](https://usenotix.dev/docs/reference/automations/create-an-automation-from-a-recipe): Create a DRAFT automation from one of the dashboard's ready-made starting points: welcome, finish-setup, win-back, trial-ending, thank-you or scratch (no… (`POST /v1/automations/from-recipe`) - [Update an automation](https://usenotix.dev/docs/reference/automations/update-an-automation): Change a draft's name, trigger, contact book, segment or steps. (`PATCH /v1/automations/{id}`) - [Activate an automation](https://usenotix.dev/docs/reference/automations/activate-an-automation): Turn a draft automation on. (`POST /v1/automations/{id}/activate`) - [Archive an automation](https://usenotix.dev/docs/reference/automations/archive-an-automation): Archive an automation for good: everyone still in it leaves it, and it sends nothing more. (`POST /v1/automations/{id}/archive`) - [Copy a template into a step](https://usenotix.dev/docs/reference/automations/copy-a-template-into-a-step): Copy a template's subject, preview text and body into an email step of a draft, as the dashboard's "Choose a template" does. (`POST /v1/automations/{id}/steps/{stepId}/template`) - [List an automation's runs](https://usenotix.dev/docs/reference/automations/list-an-automation-s-runs): The automation's runs, newest first, with the contact's id and email, the step each is on, when it moves next and why it left. (`GET /v1/automations/{id}/runs`) - [Retrieve a run](https://usenotix.dev/docs/reference/automations/retrieve-a-run): One run: who, its status, the event that started it, each step it took with what happened (sent, received, timed_out, yes, no, updated, added...), and… (`GET /v1/automations/{id}/runs/{runId}`) - [Automation metrics](https://usenotix.dev/docs/reference/automations/automation-metrics): The Metrics screen: runs started each day by how they stand (completed, running, failed), emails sent each day with the share delivered, and each step's… (`GET /v1/automations/{id}/metrics`) - [Stop an automation](https://usenotix.dev/docs/reference/automations/stop-an-automation): Stop an enabled automation for new people. (`POST /v1/automations/{id}/stop`) - [Copy an automation](https://usenotix.dev/docs/reference/automations/copy-an-automation): Make a disabled copy (DRAFT) with the same trigger, list, steps and paths, to change. (`POST /v1/automations/{id}/duplicate`) - [Import an automation](https://usenotix.dev/docs/reference/automations/import-an-automation): Copy an automation written in Resend's shape (name, steps with key, type and config, and connections). (`POST /v1/automations/import`) - [List the people in an automation](https://usenotix.dev/docs/reference/automations/list-the-people-in-an-automation): The dashboard's People table: each person's name, email, where they are in the automation and how they are doing, newest first, 25 to a page. (`GET /v1/automations/{id}/people`) - [Export an automation's people](https://usenotix.dev/docs/reference/automations/export-an-automation-s-people): The People table as CSV, newest first, at most 10,000 rows (truncated is true when there were more). (`GET /v1/automations/{id}/people/export`) - [Check an automation before activating](https://usenotix.dev/docs/reference/automations/check-an-automation-before-activating): Every finding the dashboard's review screen shows, at once: the entry, the emails' domains, empty emails, the deliverability check of each email, preview… (`GET /v1/automations/{id}/preflight`) - [Send a test of the whole automation](https://usenotix.dev/docs/reference/automations/send-a-test-of-the-whole-automation): Send a test copy of every email step at once to the team member who created the API key, and to nobody else: the request names no recipient. (`POST /v1/automations/{id}/test`) - [Pause an automation](https://usenotix.dev/docs/reference/automations/pause-an-automation): Pause an active automation. (`POST /v1/automations/{id}/pause`) - [Resume an automation](https://usenotix.dev/docs/reference/automations/resume-an-automation): Resume a paused automation, which carries on emailing the people in it. (`POST /v1/automations/{id}/resume`) - [Enrol up to 100 contacts](https://usenotix.dev/docs/reference/automations/enrol-up-to-100-contacts): Enrol 1 to 100 contacts into an automation in one call, each by contactId or by email (an email not yet in the automation's contact book is added to it). (`POST /v1/automations/{id}/enroll/batch`) - [Automation stats](https://usenotix.dev/docs/reference/automations/automation-stats): How an automation is doing over the last 30 days (range=30d, the default) or all time (range=all): how many started, are in it now, finished and left… (`GET /v1/automations/{id}/stats`) ## API reference: Events - [Events API](https://usenotix.dev/docs/reference/events): Send the events that start automations and wake the ones waiting for them, and name your events and their properties. - [Send an event](https://usenotix.dev/docs/reference/events/send-an-event): Tell Notix something happened to one person. (`POST /v1/events`) - [List events](https://usenotix.dev/docs/reference/events/list-events): Every event the team has named, with its typed properties, how many arrived in the last 30 days, when the last one arrived, and which automations start… (`GET /v1/events/definitions`) - [Create an event](https://usenotix.dev/docs/reference/events/create-an-event): Name an event and its properties, so the builder can offer it and its data is checked when it arrives. (`POST /v1/events/definitions`) - [Retrieve an event](https://usenotix.dev/docs/reference/events/retrieve-an-event): One event, by its id or its name, with its properties, figures and the automations that use it. (`GET /v1/events/definitions/{idOrName}`) - [Update an event](https://usenotix.dev/docs/reference/events/update-an-event): Replace an event's properties. (`PATCH /v1/events/definitions/{idOrName}`) - [Delete an event](https://usenotix.dev/docs/reference/events/delete-an-event): Remove an event no automation uses (409 while one starts on it or waits for it). (`DELETE /v1/events/definitions/{idOrName}`) ## API reference: Sending rules - [Sending rules API](https://usenotix.dev/docs/reference/sending-rules): Read and change quiet hours, the frequency cap, daily caps and the SMS country allow list, and see what they held back. - [Read the sending rules](https://usenotix.dev/docs/reference/sending-rules/read-the-sending-rules): The team's sending rules, as the console's Sending rules page shows them: every rule, how many are on, what they held back this month (month), today's… (`GET /v1/sending-rules`) - [Change the sending rules](https://usenotix.dev/docs/reference/sending-rules/change-the-sending-rules): Change one or more rules. (`PATCH /v1/sending-rules`) ## API reference: Deliverability - [Deliverability API](https://usenotix.dev/docs/reference/deliverability): Check a message for problems before you send it. - [Check a message before sending](https://usenotix.dev/docs/reference/deliverability/check-a-message-before-sending): Check a message before you send it and get back a report with a verdict, a score and the findings. (`POST /v1/deliverability/check`) ## API reference: Analytics - [Analytics API](https://usenotix.dev/docs/reference/analytics): Sending metrics as the Metrics page shows them, email volume over time and reputation metrics. - [Email volume over time](https://usenotix.dev/docs/reference/analytics/email-volume-over-time): Daily counts of sent, delivered, opened, clicked, bounced and complained emails for the last 7 or 30 days (30 by default), with totals, optionally for… (`GET /v1/analytics/email-time-series`) - [Read sending metrics](https://usenotix.dev/docs/reference/analytics/read-sending-metrics): The numbers on the console's Metrics page for the last 7, 15, 30 or 90 days (days, 30 by default, ending today in UTC), for every domain or one… (`GET /v1/metrics`) - [Reputation metrics](https://usenotix.dev/docs/reference/analytics/reputation-metrics): Delivered, hard-bounced and complained counts with the bounce and complaint rates, optionally for one domain. (`GET /v1/analytics/reputation-metrics`) ## API reference: Webhooks - [Webhooks API](https://usenotix.dev/docs/reference/webhooks): Create and manage the URLs Notix sends events to, send a test event, and read and retry the call log. - [List webhooks](https://usenotix.dev/docs/reference/webhooks/list-webhooks): Every webhook of the team, newest first, with a summary of its last 24 hours: calls delivered (ok), extra attempts it needed (retried) and calls that ran… (`GET /v1/webhooks`) - [Create a webhook](https://usenotix.dev/docs/reference/webhooks/create-a-webhook): Start sending events to a URL. (`POST /v1/webhooks`) - [Get a webhook](https://usenotix.dev/docs/reference/webhooks/get-a-webhook): One webhook: its URL, events, domains, status and failure count. (`GET /v1/webhooks/{webhookId}`) - [Update a webhook](https://usenotix.dev/docs/reference/webhooks/update-a-webhook): Change the URL, events, description or domains. (`PATCH /v1/webhooks/{webhookId}`) - [Pause or resume a webhook](https://usenotix.dev/docs/reference/webhooks/pause-or-resume-a-webhook): Set status to PAUSED to stop sending events, or ACTIVE to start again. (`POST /v1/webhooks/{webhookId}/status`) - [Delete a webhook](https://usenotix.dev/docs/reference/webhooks/delete-a-webhook): Stop sending events to this URL for good. (`DELETE /v1/webhooks/{webhookId}`) - [Send a test event](https://usenotix.dev/docs/reference/webhooks/send-a-test-event): Queue a webhook.test event to the webhook's saved URL, signed like a real event. (`POST /v1/webhooks/{webhookId}/test`) - [Rotate the signing secret](https://usenotix.dev/docs/reference/webhooks/rotate-the-signing-secret): Replace the signing secret with a new one. (`POST /v1/webhooks/{webhookId}/rotate-secret`) - [List webhook calls](https://usenotix.dev/docs/reference/webhooks/list-webhook-calls): The call log: every event Notix sent, or tried to send, to your webhooks, newest first. (`GET /v1/webhooks/calls`) - [Get a webhook call](https://usenotix.dev/docs/reference/webhooks/get-a-webhook-call): One call: the event data Notix sent (payload, as JSON text), each attempt's outcome, the HTTP status your endpoint answered, how long it took and the… (`GET /v1/webhooks/calls/{callId}`) - [Retry a webhook call](https://usenotix.dev/docs/reference/webhooks/retry-a-webhook-call): Send a failed or dropped call again, with the same event data, to its webhook's saved URL. (`POST /v1/webhooks/calls/{callId}/retry`) ## API reference: Billing - [Billing API](https://usenotix.dev/docs/reference/billing): Read the wallet ledger, receipts, invoices, this period's usage against your limits, your plan and your prices. - [List wallet transactions](https://usenotix.dev/docs/reference/billing/list-wallet-transactions): Every row of the team's wallet, as the billing page's ledger lists it: top-ups, Pro months, units, SMS charges and releases, sender ID fees and refunds,… (`GET /v1/billing/transactions`) - [List receipts](https://usenotix.dev/docs/reference/billing/list-receipts): The receipts in the team's wallet: paid top-ups, Pro months paid from the wallet (with their invoice number), sender ID fees and their refunds. (`GET /v1/billing/receipts`) - [Get a receipt](https://usenotix.dev/docs/reference/billing/get-a-receipt): One receipt by its reference (a transaction's receiptReference), with the figures the printable receipt shows. (`GET /v1/billing/receipts/{reference}`) - [List invoices](https://usenotix.dev/docs/reference/billing/list-invoices): The team's latest 12 Stripe invoices, newest first, as the billing page lists them: id, number, date, amounts in cents and status. (`GET /v1/billing/invoices`) - [Get an invoice](https://usenotix.dev/docs/reference/billing/get-an-invoice): One Stripe invoice of the team, by its Stripe id (in_...). (`GET /v1/billing/invoices/{id}`) - [Get the plan](https://usenotix.dev/docs/reference/billing/get-the-plan): The team's plan and how it is paid: the card subscription (status, period, whether it cancels at the period's end), the wallet's state (renewal date,… (`GET /v1/billing/subscription`) - [Get usage](https://usenotix.dev/docs/reference/billing/get-usage): The figures the Usage and billing pages show: this billing period's emails against the monthly and daily limits (the daily limit is the one enforced… (`GET /v1/billing/usage`) - [Get prices](https://usenotix.dev/docs/reference/billing/get-prices): The package price list the billing page's Pricing table shows, in the team's billing currency (USD for a team that has not chosen one): each channel's… (`GET /v1/billing/pricing`) - [Get spend and limits](https://usenotix.dev/docs/reference/billing/get-spend-and-limits): What the Spend and limits page shows: this calendar month's spend (UTC, from the 1st) on texts (SMS), one-time codes (OTP), pay-as-you-go email (EMAIL)… (`GET /v1/billing/spend`) - [Set or lower a monthly budget](https://usenotix.dev/docs/reference/billing/set-or-lower-a-monthly-budget): Creates the monthly budget for SMS, OTP or EMAIL, in the wallet currency's minor unit, or tightens the one it has. (`PUT /v1/billing/spend/budgets/{channel}`) - [Remove a monthly budget (dashboard only)](https://usenotix.dev/docs/reference/billing/remove-a-monthly-budget-dashboard-only): Removing a budget lifts a limit, so the API refuses it: a channel that has a budget answers 403 FORBIDDEN ("Raising or removing a budget can only be done… (`DELETE /v1/billing/spend/budgets/{channel}`) ## API reference: Logs - [Logs API](https://usenotix.dev/docs/reference/logs): Read every request your API keys and AI tools made in the last 30 days. - [List API requests](https://usenotix.dev/docs/reference/logs/list-api-requests): Every request the team's API keys and AI tools made, newest first, a page at a time. (`GET /v1/logs`) - [Read one API request](https://usenotix.dev/docs/reference/logs/read-one-api-request): One request, with what Notix kept of its bodies. (`GET /v1/logs/{id}`)