Table of Contents

• About the REST APIs
• All REST Endpoints

Get Started

• Quick Start
• Changes and Enhancements in Recent Releases
• Send Requests
• Access Controls
  • Functional Access Control
  • Organizational Access Control
  • Login IP Enforcement Access Control (optional)
• Authentication
  • Log in with username and password
  • Log in with username and certificates
  • Refreshing Tokens
  • OAuth Authentication using IDCS
• Get Throttling Limits
• Definitions of Rule Parameters
• API Data Types
• Handling Errors
  • Handling Errors Part 1
  • Handling Errors Part 2
  • Handling Errors Part 3
  • Handling Recipient Errors
  • Internal Capacity Limits
• Handling System Outages
• Migration Notes
• Other Responsys APIs

Tasks

• Account
  • Add Email Domain Rules
  • Delete Email Domain Rules
  • Get Account Settings for a User
  • Get Email Domain Rules
  • Get Email Footer
  • Get Endpoint URL for a User
  • Get User Information
• Attachments
  • Merge Trigger Email With Attachments
  • Trigger Email Message with Attachments
• Campaign Attributes
  • Retrieve a Campaign's Proof List
  • Retrieve Campaign Data Sources
  • Update a Campaign's Proof List
• Campaigns
  • Fetch A Campaign
  • Fetch All Campaigns
  • Fetch Campaigns using filters
  • Preview a Campaign
• Content Library Document Images
  • Retrieve binary content of images in a Content Library Document
  • Update content of images in a Content Library Document
• Content Library Documents
  • Create a Content Library Document
  • Create a copy of a Content Library Document.
  • Delete a Content Library Document
  • Retrieve contents of a Content Library Document
  • Update Contents of a Content Library Document
• Content Library Folders
  • Create Content Library Folder
  • Delete Content Library Folder
  • List contents of a Content Library Folder
• Content Library Media Items
  • Create a Content Library Media File
  • Create a copy of a Content Library Media file.
  • Delete a Content Library Media File
  • Retrieve contents of a Content Library Media File
  • Update a Content Library Media File
• Email or Push Campaign Schedule
  • Create an Email or Push campaign schedule
  • Delete an Email or Push campaign schedule
  • Fetch All Email or Push Campaign Schedules
  • Retrieve an Email or Push campaign schedule
  • Update an Email or Push campaign schedule
• Events
  • Fetch All the Custom Events
  • Trigger Custom Event
  • Trigger REI Event
• Filters
  • Retrieve All Filters
• Folders
  • Create a Folder
  • Retrieve Account Folders
  • Retrieve Folder Content
• List Extensions
  • Create Profile Extension
  • Fetch All Profile Extensions for a Profile List
• Merge Trigger Email
  • Merge Trigger Email
• Merge Trigger SMS
  • Merge Trigger SMS
• Organizations
  • Fetch a campaign's organization hierarchy
  • Fetch a program's organization hierarchy
  • Fetch all organizations
  • Update a campaign's organizational access
  • Update a program's organizational access
• Profile Extension Recipients
  • Delete multiple Profile Extension Recipients
  • Delete Profile Extension Recipient using an RIID
  • Merge Profile Extension Recipients
  • Retrieve Multiple Profile Extension Recipients
  • Retrieve Profile Extension Recipient using a query attribute
  • Retrieve Profile Extension Recipient using an RIID
• Profile List Recipients
  • Delete List Recipients based on RIID
  • Delete multiple Profile List Recipients
  • Delete Profile List Recipients using query attribute
  • Merge List Recipients
  • Retrieve List Recipient using query attribute
  • Retrieve List Recipient using RIID
  • Retrieve List Recipients Count using query attribute
  • Retrieve multiple Profile List Recipients
• Profile Lists
  • Add or Update RIID in the Organizational Scope Mapping
  • Create a Profile List with or without brand Context
  • Fetch All Profile Lists
  • Retrieve Profile List Fields
  • Retrieve Proof Lists
  • Retrieve Segment Groups
• Programs
  • Exit Enactments
  • Fetch a Program by Name
  • Fetch All Programs
  • Fetch Programs for a Profile List
  • Publish or Unpublish a Program
• Supplemental Table Members
  • Delete Supplemental Table member based on a query attribute
  • Fetch all the fields or the primary key fields of the Supplemental Table
  • Merge Supplemental Table members with PK
  • Merge Table Records
  • Retrieve Supplemental Table member based on a query attribute
• Supplemental Tables
  • Create Supplemental Table
  • Fetch All Supplemental Tables
  • Update Supplemental Table
• Trigger Email Message
  • Trigger Email Message
• Trigger Push Message
  • Trigger Push Message
• Trigger SMS Message
  • Trigger SMS Message