Aysali logo

General

Subscribe visitors to your mailing list automatically when they share an email in Aysali Bot. Configure Settings → General → Newsletter and connect one of the supported providers.

When users are subscribed

sb_newsletter() runs when an email address is saved on a user profile:

TriggerHow it happens
Registration formUser completes chat registration (add-user / update-user-and-message)
Follow-up messageVisitor submits the email rich message ([email id="sb-follow-up" …]) — profile is updated via update-user-and-message
Subscribe messageSame email rich-message flow when the shortcode collects an address
Email shortcodeAny [email …] rich message that updates the user record
Profile updateEmail field changed in Users or via API (update-user, update-user-and-message)

Setup

  1. •

    Choose a service

    Open Settings → General → Newsletter, pick Service, and note the provider-specific Key and List ID instructions below.

  2. •

    Enter credentials

    Paste Key and List ID into the matching fields. Use the exact format each provider expects (some use domain:id or URL|listId).

  3. •

    Activate

    Enable Active and save. Test with a registration or follow-up form using a disposable address.

SettingPurpose
ActiveMaster switch for all newsletter sync
ServiceProvider integration (16 options)
List IDAudience, list, group, or form ID (format varies)
KeyAPI key, token, or provider-specific secret

Admin API

Agents can call the newsletter RPC with email and optional first_name / last_name when Active is enabled (see OpenAPI Request_newsletter).

Mailchimp

Key — Create an API key: About API keys.

List ID — Audience ID: Find audience ID.

The integration builds the API URL from the datacenter suffix in your key (the part after - in xxxxxxxx-us19).

Brevo (Sendinblue)

Key — Brevo API keys.

List ID — Lists — numeric list ID.

SendGrid

Key — API keys (Marketing API access).

List ID — In SendGrid, open Marketing → Contacts (contacts), open or create a list. The list ID is the last segment of the URL, for example 8558c1e7-3c99-4428-a68f-78df2e437f8e from
https://mc.sendgrid.com/contacts/lists/8558c1e7-3c99-4428-a68f-78df2e437f8e.

Elastic Email

Key — In Elastic Email: profile menu → Settings → Create Additional API key. Choose Plugin, Full access, or Custom with Contacts → View & Modify.

List ID — The list name (not a numeric ID). Existing list and segment names must not contain spaces.

Campaign Monitor

Key — Account settings → API keys → Generate API key.

List ID — Lists and subscribers → select a list → Settings → copy List API ID.

HubSpot

Key

  1. Settings → Integrations → Private apps → create an app.
  2. On Scopes, add: crm.lists.write, crm.lists.read, crm.objects.contacts.read, crm.objects.contacts.write.
  3. Create the app and copy the access token into Key.

List ID — Contacts → Lists → open a list → List details.

Moosend

Key — Settings → API key.

List ID — Audience → Email lists.

GetResponse

Key — GetResponse API.

List ID — Lists → your list → Settings (lists) — copy List token.

ConvertKit

Key — Settings → Advanced → API secret.

List ID — Grow → Landing Pages & Forms — open a form; the numeric ID is in the URL (for example 3003412 in https://app.convertkit.com/forms/designers/3003412/edit).

ActiveCampaign

Key — Account settings → Developer.

List ID — Lists or Contacts → Lists — open a list; the ID appears in the URL (listid=1). Enter domain:list-id: the domain is the first part of your dashboard host (for https://schiocco.activehosted.com/ use schiocco:1).

MailerLite

Key — Integrations → MailerLite API.

List ID — Subscribers → Groups — open a group; copy Group ID from the URL (for example group=18783408688903967).

Mailjet

Key — API keys or Account settings. Enter API Key and Secret Key separated by a comma: your-api-key,your-secret-key.

List ID — Contacts → Contact lists → open a list → click ? next to the list email (for example 1202546).

Sendy

Key — Copy API KEY from your Sendy installation settings.

List ID — Open your brand → View all lists → copy the list ID. Enter full-sendy-url|list-id, for example https://example.com|TDf6o892Mx11VXGC51ui567u.

SendFox

Key — Settings → API → Personal Access Tokens.

List ID — Audience → Lists — open a list; ID is in the URL (for example 489151 in https://sendfox.com/dashboard/lists/489151/contacts).

Klaviyo

Key — Settings → Account → API keys — use the Public API key / Company ID value required by the client subscription endpoint (company_id in the integration URL).

List ID — Lists — open a list; ID is in the URL (for example Y8364W in https://www.klaviyo.com/list/Y8364W/).

Acumbamail

Key — See Acumbamail API docs for your auth token.

List ID — Lists — open a list; ID is in the URL (for example 1225126 in https://acumbamail.com/app/list/1225126/).