Email Broadcast System - API Documentation

App Command (API Call)
POST your request to https://api.aiappsapi.com with your API key and account ID in the POST body. The fields described in each section below go inside the jsonData POST field as a JSON-encoded string. Use this method when your server is making the call and you have your API credentials available.

Mode / Webhook (Direct URL)
POST directly to the endpoint URL shown in each section. The fields go in the POST body as standard form fields (the same fields you would include in an HTML form POST). Use this method for provider webhooks, website forms, or any third-party system that sends form data. No API key is required - the account ID is part of the URL.

Each supported email provider gets a dedicated webhook URL. Enter this URL in your provider account wherever it asks for an event notification URL, a webhook endpoint, or a delivery callback URL. The system tracks deliveries, bounces, opens, clicks, spam complaints and unsubscribes automatically. Hard bounces, spam complaints and unsubscribes will suppress the email address from all future sends.

Adds a new subscriber record to your email list. This is the primary way to get contacts into the system - from a web form, a data feed partner, or any lead source. If the email address is already on your suppression list (from a previous unsubscribe or hard bounce), the record will not be added. If the address was previously pruned for inactivity, it will be re-imported automatically.

Removes an email address from your active subscriber list and adds it to your suppression file. Once suppressed, that address will not receive any future broadcasts regardless of how it was added. You can suppress globally or for a specific sending domain only. Webhook events from your email provider (hard bounces, spam complaints, unsubscribes) are handled automatically by the system, but you can also trigger an unsubscribe manually using this endpoint.

Sends an individual email message to one address immediately. The sending domain you specify must already be configured in your account with valid SMTP credentials. The system looks up the SMTP host, username, password, port, sender address and sender name from your domain settings automatically. This endpoint is for on-demand single sends - for sending to a list, use the broadcast scheduling features in the dashboard.

Enrolls an email address into an automated responder series. Once enrolled, the contact receives a sequence of messages at scheduled intervals (daily, weekly, or monthly) as configured in the series settings in your dashboard. Each subscriber gets their own independent schedule starting from when they enrolled. If the first message is due and the current time is between 8am and 5pm Eastern, it sends immediately.

Stops an email address from receiving further messages in a responder series. You can remove a subscriber from one specific series or from all series at once. The email address is also added to the global suppression list. This does not affect broadcast sends - to fully suppress an address from all broadcasts as well, also call the unsubscribe endpoint.