canonical: https://jentic.com/apis/everlytic.com/everlytic # Everlytic API The Everlytic API is the programmatic surface for Everlytic's email marketing, SMS, and push notification platform. Fourteen operations across 7 paths cover contact and list management, campaign messages, and transactional email and SMS sends. Authentication is via HTTP Basic, and the API is the right surface for syncing customer data from CRMs and product systems into Everlytic, triggering transactional messages from app events, and powering AI agents that send branded communications on demand. ## For AI agents Manage Everlytic contacts and lists, retrieve campaign messages, and send transactional email or SMS for marketing and product notification workflows. ## Scope Does not handle payment processing, customer support ticketing, or web push notification config - use for Everlytic contacts, lists, and transactional email and SMS only. ## Capabilities - Create, retrieve, update, and remove contacts in Everlytic - Manage subscription lists and the contacts subscribed to them - Read campaign and transactional message records - Send a transactional email through `/transactional/email` - Send a transactional SMS through `/transactional/sms` - Pipe customer events from a CRM or product into segmented Everlytic lists ## Use cases ### CRM to Everlytic Sync Mirror contacts from a CRM into Everlytic so marketing campaigns always run against the latest segments. The /contacts and /lists endpoints provide create, read, update, and delete operations needed for two-way sync. A working sync takes a day or two and removes the manual CSV imports that marketing teams typically perform monthly. Example prompt: On every CRM contact update, POST /contacts to Everlytic if new or PUT `/contacts/{id}` if existing, and add to the matching list via `/lists/{id}` ### Transactional Email Triggers Trigger transactional emails from product events such as 'order shipped' or 'password reset' by calling `/transactional/email` with a templated payload. This keeps transactional sends inside the same platform as marketing sends, simplifying analytics and unsubscribe handling. Setup typically takes a single afternoon. Example prompt: When a new order ships, POST `/transactional/email` with the customer's email, template ID, and order tracking number ### SMS Reminders for Appointments Send SMS appointment reminders or two-factor codes through `/transactional/sms`, replacing a separate SMS gateway. The API accepts the destination number and message and returns a send identifier for receipts. This collapses two vendors into one for South African and African market deployments where Everlytic is widely used. Example prompt: Send an SMS via `/transactional/sms` to a customer with their appointment time and a confirmation link ### AI Agent Integration via Jentic Wire Everlytic to an AI assistant through Jentic so internal staff can send a transactional email or SMS in chat without leaving Slack. Jentic search resolves the intent to the right Everlytic operation and the vault holds the credentials. Setup takes minutes once Everlytic is connected. Example prompt: Search Jentic for 'send everlytic transactional email', load the POST `/transactional/email` operation, and send a templated message captured from chat ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | `/contacts` | List contacts | | POST | `/contacts` | Create a contact | | PUT | `/contacts/{id}` | Update a contact | | GET | `/lists` | List subscription lists | | POST | `/lists` | Create a list | | POST | `/transactional/email` | Send a transactional email | | POST | `/transactional/sms` | Send a transactional SMS | ## Key resources - **Contacts** — Create, read, update, and delete contacts - **Lists** — Manage subscription lists and the contacts subscribed to them - **Messages** — Read campaign and transactional message records - **Transactional** — Send transactional email and SMS ## Why Jentic - **Setup:** Wiring Everlytic by hand means handling its Basic Auth, filling in your {instance}.everlytic.net host, and coding the contact, list, and transactional email and SMS calls yourself. Through Jentic you install once, import the Everlytic API from the API Directory, store the credentials once, and your agent calls it. - **Permission scoping:** Everlytic puts the contact id in the URL path for updates (`/contacts/{id}`) but sends transactional email and SMS through body payloads, so scope the agent to the operations it needs, such as creating contacts and sending transactional email, rather than to one message. Every operation you credit the agent with comes from the allowed set you define. - **Credential handling:** Your Everlytic Basic Auth username and password are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'send an everlytic transactional email' or 'add a contact to a list', and Jentic returns the matching Everlytic operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Mailchimp Marketing API** — Global email marketing platform with broader template and automation features - **Brevo API** — Email, SMS, and chat marketing platform formerly known as Sendinblue - **SendGrid Domain Authentication API** — Run high-volume transactional email through SendGrid alongside Everlytic marketing - **Klaviyo API** — E-commerce-focused email and SMS platform with deep behavioural segmentation ## FAQ ### What authentication does the Everlytic API use? The Everlytic API uses HTTP Basic authentication. Through Jentic, the credentials sit in the encrypted vault and are injected at execution time, so the raw username and password never enter the agent's context. ### Can I send transactional emails through the Everlytic API? Yes. POST `/transactional/email` sends a single transactional email with a template and per-recipient merge fields. This is suited to order confirmations, password resets, and other product-driven sends that should share analytics with marketing campaigns. ### What are the rate limits for the Everlytic API? The OpenAPI spec does not declare explicit rate limits. Treat the API as standard for an email service provider, back off on HTTP 429, and consult Everlytic's developer documentation for current published limits before bulk sends. ### How do I sync contacts to Everlytic through Jentic? Search Jentic for 'everlytic create contact' and 'everlytic add to list', load the POST /contacts and `/lists/{id}` operations, and execute them in sequence. Install with pip install jentic and use the async search, load, execute pattern. ### Does the Everlytic API support SMS sends? Yes. POST `/transactional/sms` sends a single SMS to a destination number with the message body. This is widely used for appointment reminders and 2FA codes in markets where Everlytic is the established provider. ### Can I manage list subscriptions via the API? Yes. /lists and `/lists/{id}` cover list-level CRUD, and contact list membership is managed through the contacts and lists endpoints. This is the right surface for syncing CRM segments into Everlytic without touching the dashboard. ### Can I limit what my agent is allowed to do with the Everlytic API? Yes. Because you run Jentic One yourself, your own rules define the allowed set of Everlytic operations and credentials the agent may use. You can grant only the operations a task needs, such as creating a contact (POST /contacts) or sending a transactional email (POST `/transactional/email`), while withholding others like updating a contact at `/contacts/{id}` or sending SMS through `/transactional/sms.` Since transactional email and SMS go through body payloads rather than the URL path, scope the agent to those specific operations rather than trying to restrict individual messages.