Actions

59 actions

Action

Description

List Campaign Drafts

Retrieve a list of editable marketing campaign drafts (newsletters) with optional filtering.

Get Campaign Draft

Retrieve a single editable campaign draft (newsletter) by its draft ID.

Create Campaign Draft

Create a new marketing campaign draft (newsletter) shell to later add content to and send.

Update Campaign Draft

Update the settings (sender, subject, target list) of an existing campaign draft.

Get Campaign Draft Content

Retrieve the email body (HTML, text, MJML) of a campaign draft.

Update Campaign Draft Content

Add or replace the email body (HTML, text, MJML) of a campaign draft.

Send Campaign Draft

Send a marketing campaign draft (newsletter) immediately to its whole target contact list.

Schedule Campaign Draft

Schedule a marketing campaign draft to be sent to its target list at a future date/time.

Test Campaign Draft

Send a preview/test copy of a campaign draft to specific recipients before the real send.

List Campaigns

Retrieve a list of already-sent campaigns (marketing and transactional) with optional filtering.

Get Campaign

Retrieve a single already-sent campaign record by its campaign ID.

List Contact Lists

Retrieve all contact lists on the account (not scoped to any single contact).

Get Contact List

Retrieve a single contact list (its name, address, subscriber count) by list ID.

Create Contact List

Create a new empty contact list (mailing list) on the account.

Update Contact List

Rename an existing contact list, or mark it deleted/restored.

Delete Contact List

Permanently delete a contact list by its list ID.

Manage List Contact

Subscribe, update, or unsubscribe ONE contact to/from ONE contact list (synchronous).

Manage List Contacts (Bulk)

Upload MANY contacts to ONE contact list in one asynchronous bulk job (returns a JobID).

List Contact Properties

Retrieve the account-wide custom-field DEFINITIONS (the property schema), not per-contact values.

Get Contact Property

Retrieve a single custom-field DEFINITION (property schema) by its ID.

Create Contact Property

Define a new account-wide custom contact field (property definition).

Update Contact Property

Rename or retype an existing account-wide custom-field DEFINITION.

Delete Contact Property

Permanently delete an account-wide custom-field DEFINITION by its ID.

List Contacts

Retrieve a list of contacts on the account with optional filtering.

Get Contact

Retrieve a single contact by numeric ID or email address.

Create Contact

Create a new contact on the account (email required).

Update Contact

Update an existing contact's display name or campaign-exclusion (suppression) setting.

Get Contact Data

Retrieve the custom-field VALUES stored on a single contact.

Update Contact Data

Set or update the custom-field VALUES on a single contact.

Get Contact's Lists

Retrieve the contact lists that ONE specific contact belongs to (with per-list subscription status).

Manage Contact's Lists

Subscribe or unsubscribe ONE contact across MANY contact lists in one call (contact ID in path).

List Messages

Retrieve a list of individual processed (sent) messages with rich filtering.

Get Message

Retrieve delivery details for a single processed message by its message ID.

Get Message Information

Retrieve size, spam-score, and delivery statistics for a single message by its message ID.

List Segments

Retrieve a list of contact segmentation filters used to dynamically target campaigns.

Get Segment

Retrieve a single contact segmentation filter (including its expression) by ID.

Create Segment

Create a new contact segmentation filter from a targeting expression.

Update Segment

Update the name, description, expression, or status of a segmentation filter.

Delete Segment

Delete a contact segmentation filter by ID (must not be in use).

Send Email

Send one or more transactional emails to specific recipients via the Send API v3.1.

List Senders

Retrieve the sender addresses and domains configured on the API key, with validation status.

Get Sender

Retrieve a single sender (address/domain and its validation status) by sender ID.

Create Sender

Update Sender

Update the display name, email type, or default flag of an existing sender.

Delete Sender

Delete a sender from the API key by its sender ID.

Validate Sender

Trigger validation of a sender (resend activation email or re-check domain DNS).

List Statistics Counters

Retrieve aggregated messaging statistics (sent, opened, clicked, bounced) grouped by source and time.

List Templates

Retrieve a list of reusable email templates with optional filtering.

Get Template

Retrieve a single template's metadata by its template ID.

Create Template

Create a new reusable email template shell (content added separately).

Update Template

Update an existing template's metadata (name, purposes, categories, etc.).

Delete Template

Permanently delete a reusable email template by its template ID.

Get Template Content

Retrieve the email body (HTML, text, MJML) of a template.

Update Template Content

Add or replace the email body (HTML, text, MJML) of a template.

List Event Callbacks

Retrieve the Event API callback (webhook) URLs registered on the account.

Get Event Callback

Retrieve a single Event API callback (webhook) URL by its ID.

Create Event Callback

Update Event Callback

Update an existing Event API callback (webhook) URL, or reactivate a suspended one.

Delete Event Callback

Delete an Event API callback (webhook) URL by its ID.