API: HTTP

Overview

Introduction and overview of the HTTP API tools.

• Accessing the API
• Security
• Conventions
• Commands
• Code Examples

Lists

Lists and List Definitions define the properties required for deploying an email message.

• Lists
• Create List Definition
• Create List
• Create List from List Definition
• Copy List
• Update List Definition

List Attributes

List Attributes allow you to create groups of values which can be associated to specific Lists or List Definitions and applied to emails.

• List Attributes
• Create List Attribute
• Update List Attribute
• Delete List Attribute
• Get List Attributes
• Get List Attribute Values for List

Segmentation Rules

Segment, or temporarily split, lists for the purpose of targeting specific contacts.

• Segmentation Rules
• Create Segmentation Rule
• Update Segmentation Rule
• Delete Segmentation Rule
• Show Segmentation Rules
• Test Segmentation Rule

Templates

Templates and Layouts are the main repository for content sent to contacts.

• Templates
• Create Template
• Copy Template
• Update Template
• Show Templates
• Get Template

Articles

Articles are reusable content pieces.

• Articles
• Create Article
• Copy Article
• Update Article
• Delete Article
• Show Articles

Custom Contact Data

Store additional data about your contacts in custom data fields.

• Custom Fields
• Create Custom Field
• Delete Custom Field

Folders

Folders

• Folders
• Create Folder
• Get Folder ID

Social Media

Social Media

• Social Media
• Get Social Providers
• Get Social Provider by ID
• Get Social Provider by User Name
• Delete Social Provider by ID
• Delete Social Provider by User Name

Contact Management

Create, edit, and delete contacts individually or in batches and manage subscriptions.

• Contact Management
• Subscribe to List
• Update Contact
• Change Email Address
• Unsubscribe from List
• Delete Contact

Relational Data

The HTTP API allows you to manage Relational Data Tables. You can insert records and find selected records.

• Relational Data
• Add Table
• Add Fields
• Add Active Fields
• Add Foreign Key
• Activate Table

SMS Management

Manage SMS subscriptions and send messages via SMS.

• SMS
• Create SMS Message
• Get SMS Messages
• Add Phone to Sender Code
• Add SMS Contact to Sender Code
• Send Message to Sender Code

Send Mail

Send Mail

• Send Mail
• Get Fillin Fields
• Get Test Count
• Send One-Off Message
• Subscribe and Send One-Off Message
• Launch Campaign

A/B Testing

A/B Testing

• A/B Testing
• Show A/B Definitions
• Get A/B Definition
• Report A/B Test Statistics
• Choose A/B Winner

Reports

Reports

• Reports
• Get Labels
• Show Campaigns
• Report Campaign List
• Show Campaign Statistics
• Show Multiple Campaign Statistics

Realm Management

Realm Management

• Realm Management
• Get Realm Settings

Account Profiles

Create fields defined at the Account Realm level and defined in groups which can be applied to email content.

• Account Profiles
• Create Account Profile Field
• Create Account Profile
• Update Account Profile
• Update Account Profile Values
• Get All Account Profile Fields

Product Feed

• Product Feed Overview
• Add Product to Catalog
• Update Product in Catalog
• Activate Product
• Deactivate Product

Frequently Asked Questions

Quick answers to specific questions about the HTTP API.

• Commands report Success with invalid Folder ID
• Changing email address for Customer Key contact
• One-off Sends and Workflow