API Index

REST HTTP API

You can send email using the REST HTTP endpoint. This allows you to send a single message or a batch of messages in a single API call.

SMTP

SMTP is not an API, but a protocol used to inject email. Delivery details of each message can be customized by adding X-headers. You can create authorized users for SMTP sending through the API. Multiple SMTP servers can be configured.

Linux Pipe

Pipe email into a Linux command-line program from the same server as your GreenArrow install. GreenArrow provides programs compatible with both sendmail and qmail. This is not an HTTP API, but a standard, well-documented interface for injecting email.

Marketing Studio Campaigns

GreenArrow Studio’s API has endpoints to schedule email campaigns and create automatically triggered autoresponders. Autoresponders can be triggered by an API endpoint and can contain additional replacement data, which together provide a triggered email template feature.

Retrieve email campaign overview statistics and details on the delivery results of every recipient. Also retrieve an embeddable HTML report that can be dropped into your website or application.

Specific end-points in Marketing Studio provide detail for email campaign statistics and autoresponder statistics.

GreenArrow Marketing Studio’s API provides the ability to manage subscribers, mailing lists, custom fields, segmentation criteria, suppression lists, and list segments. You can fire off bulk subscriber imports and check on their status.

Instead of importing subscribers, you can use GreenArrow Studio’s Remote Lists feature to your remote database, run an SQL query, and get a custom subscriber list for each campaign. This can be scheduled through the API.

Configure multiple IP Addresses for email delivery. Each IP can have its own throttling rules or you can organize for easier management by defining throttling rule templates.

Automatically respond to changing delivery conditions through Dynamic Delivery throttle programs. Intelligently split mail over multiple IP addresses using VirtualMTAs, and hand email off to other SMTP servers with Relay Servers.

Sign email with DKIM keys and configure multiple signatures per message. Configure different classes of email that are treated differently.

Receive email at incoming email domains and mailboxes at those domains. Mailboxes can be configured to forward email, deliver it to user mailboxes via a Maildir/Mbox file, deliver to a POP3 user, or pipe to a program for delivery.

Web-hook notifications can be sent for clicks and opens, unsubscribes, bounces, and spam complaints.

Marketing Studio provides additional information for clicks and opens and unsubscribes, and provides a subscriber creation or update web-hook.

Programmatically customize email delivery with a hook to override default delivery behavior.

Marketing Studio’s Special Sending Rules feature allows you to fully customize emails by writing Perl or PHP code that can be called for each email sent.

Email Service Providers who deploy GreenArrow Marketing Studio for their users are able to manage customer accounts and manage user accounts. They can set customer permissions, subscriber quotas, and sending quotas through the organization API. For billing and management they can get email volume and subscriber counts for a customer account and a list of all campaigns from all customer accounts.