The Elaine functional API reference documents the HTTP-callable functions for recipients, campaigns, messages, content, data structures, imports, statistics, and templates. Start with the cURL request guide, then open the reference area that matches the object or operation you need.
Quick start
- Obtain an Elaine-issued Bearer JWT for a dedicated API identity.
- Use the HTTPS endpoint
/http/api/<function-name>. - Pass function parameters as an ordered JSON array.
- Request a JSON response and evaluate the documented return value or error code.
export ELAINE_BASE_URL="https://your-elaine-domain.example"
export ELAINE_JWT="replace-with-an-elaine-issued-jwt"
curl --get "$ELAINE_BASE_URL/http/api/api_getElaineVersion" \
--header "Authorization: Bearer $ELAINE_JWT" \
--data-urlencode 'json=[false]' \
--data-urlencode 'response=json'Common integration use cases
- Send a transactional message
- Create or update a contact and start a campaign
- Submit a generic event to Elaine
- Build HTTP requests with Bearer JWT and cURL
Functional reference
| Reference area | Includes |
|---|---|
| General functions | Instance details, tenant data sources, versions, background jobs, and health information. |
| Recipients and groups | Profiles, group membership, subscriptions, opt-in queues, mappings, blacklist, and profile history. |
| Message management | Create, copy, address, approve, start, pause, stop, inspect, and manage messages. |
| Marketing automation | Campaign status, execution, and direct contact subscription. |
| Transactional messages | Submit a transactional message and retrieve its status. |
| Content handling | Create articles and compositions, import content, list folders, and personalize text. |
| Content properties | Read, set, and delete content attributes. |
| Data fields | Create, change, inspect, and delete profile data fields. |
| Imports | Retrieve file-import processing status. |
| Statistics | Recipient-group and sent-message statistics. |
| Templates | List templates and retrieve template content. |
| Return codes | Negative function return values and their meaning. |
Note
The functional reference is based on the established Elaine API contract. Availability depends on the Elaine release, licensed features, project configuration, and permissions of the API identity.