REST API for Oracle Responsys Marketing Cloud Service

All REST Endpoints

Account

API endpoints to enable managing your Responsys account.

Add Email Domain Rules: Method: put
Path: /rest/api/v1.3/settings/account/domains/email
Delete Email Domain Rules: Method: delete
Path: /rest/api/v1.3/settings/account/domains/email/{domainRuleType}/{domainName}
Get Account Settings for a User: Method: get
Path: /rest/api/v1.3/settings/account
Get Email Domain Rules: Method: get
Path: /rest/api/v1.3/settings/account/domains/email
Get Email Footer: Method: get
Path: /rest/api/v1.3/settings/account/footer
Get Endpoint URL for a User: Method: get
Path: /rest/api/v1.3/settings/account/endpoint
Get User Information: Method: get
Path: /rest/api/v1.3/user/info

Attachments

Send Responsys Email Campaigns with Attachments

Merge Trigger Email With Attachments: Method: post
Path: /rest/api/v1.3/campaigns/{campaignName}/emailAttachments
Trigger Email Message with Attachments: Method: post
Path: /rest/api/v1.3/campaigns/{campaignName}/emailAttachments/actions/trigger

Campaign Attributes

Campaign Attributes API endpoints.

Retrieve a Campaign's Proof List: Method: get
Path: /rest/api/v1.3/campaigns/{campaignName}/attributes/proofList
Retrieve Campaign Data Sources: Method: get
Path: /rest/api/v1.3/campaigns/{campaignName}/attributes/dataSources
Update a Campaign's Proof List: Method: put
Path: /rest/api/v1.3/campaigns/{campaignName}/attributes/proofList

Campaigns

Responsys Campaign API Endpoints

Fetch A Campaign: Method: get
Path: /rest/api/v1.3/campaigns/{campaignName}
Fetch All Campaigns: Method: get
Path: /rest/api/v1.3/campaigns
Fetch Campaigns using filters: Method: post
Path: /rest/api/v1.3/campaigns/actions/search
Preview a Campaign: Method: get
Path: /rest/api/v1.3/campaigns/{campaignName}/preview

Content Library Document Images

Retrieve binary content of images in a Content Library Document: Method: get
Path: /rest/api/v1.3/clDocImages/{documentPath}
Update content of images in a Content Library Document: Method: post
Path: /rest/api/v1.3/clDocImages/{documentPath}

Content Library Documents

Documents in the Responsys Interact Suite Content Library.

Create a Content Library Document: Method: post
Path: /rest/api/v1.3/clDocs
Create a copy of a Content Library Document.: Method: put
Path: /rest/api/v1.3/clDocs/{docPath}
Delete a Content Library Document: Method: delete
Path: /rest/api/v1.3/clDocs/{docPath}
Retrieve contents of a Content Library Document: Method: get
Path: /rest/api/v1.3/clDocs/{docPath}
Update Contents of a Content Library Document: Method: post
Path: /rest/api/v1.3/clDocs/{docPath}

Content Library Folders

Content Library Folders in the Responsys Interact Suite Content Library.

Create Content Library Folder: Method: post
Path: /rest/api/v1.3/clFolders
Delete Content Library Folder: Method: delete
Path: /rest/api/v1.3/clFolders/{folderPath}
List contents of a Content Library Folder: Method: get
Path: /rest/api/v1.3/clFolders/{folderPath}

Content Library Media Items

Media Files in the Responsys Interact Suite Content Library.

Create a Content Library Media File: Method: post
Path: /rest/api/v1.3/clItems
Create a copy of a Content Library Media file.: Method: put
Path: /rest/api/v1.3/clItems/{destinationItemPath}
Delete a Content Library Media File: Method: delete
Path: /rest/api/v1.3/clItems/{itemPath}
Retrieve contents of a Content Library Media File: Method: get
Path: /rest/api/v1.3/clItems/{itemPath}
Update a Content Library Media File: Method: post
Path: /rest/api/v1.3/clItems/{itemPath}

Email or Push Campaign Schedule

Schedule an Email or a Push Campaign

Create an Email or Push campaign schedule: Method: post
Path: /rest/api/v1.3/campaigns/{campaignName}/schedule
Delete an Email or Push campaign schedule: Method: delete
Path: /rest/api/v1.3/campaigns/{campaignName}/schedule/{scheduleId}
Fetch All Email or Push Campaign Schedules: Method: get
Path: /rest/api/v1.3/campaigns/{campaignName}/schedule
Retrieve an Email or Push campaign schedule: Method: get
Path: /rest/api/v1.3/campaigns/{campaignName}/schedule/{scheduleId}
Update an Email or Push campaign schedule: Method: put
Path: /rest/api/v1.3/campaigns/{campaignName}/schedule/{scheduleId}

Events

Raise Events for Cross-channel Marketing Programs.

Fetch All the Custom Events: Method: get
Path: /rest/api/v1.3/events
Trigger Custom Event: Method: post
Path: /rest/api/v1.3/events/{eventName}
Trigger REI Event: Method: post
Path: /rest/api/v1.3/events/rei/{eventName}

Filters

Filters in the Responsys Interact Suite

Retrieve All Filters: Method: get
Path: /rest/api/v1.3/filters

Folders

Responsys Account Folder API Endpoints

Create a Folder: Method: post
Path: /rest/api/v1.3/folders
Retrieve Account Folders: Method: get
Path: /rest/api/v1.3/folders
Retrieve Folder Content: Method: get
Path: /rest/api/v1.3/folders/{folderName}/content

List Extensions

Profile Extensions for a Profile List in the Responsys Interact Suite

Create Profile Extension: Method: post
Path: /rest/api/v1.3/lists/{listName}/listExtensions
Fetch All Profile Extensions for a Profile List: Method: get
Path: /rest/api/v1.3/lists/{listName}/listExtensions

Merge Trigger Email

Merge Members to a Profile List and Send Responsys Email Campaigns to them.

Merge Trigger Email: Method: post
Path: /rest/api/v1.3/campaigns/{campaignName}/email

Merge Trigger SMS

Merge Members to a Profile List and Send Responsys SMS Campaigns to them

Merge Trigger SMS: Method: post
Path: /rest/api/v1.3/campaigns/{campaignName}/sms

Organizations

Responsys Organizations

Fetch a campaign's organization hierarchy: Method: get
Path: /rest/api/v1.3/attributes/campaigns/{campaignName}
Fetch a program's organization hierarchy: Method: get
Path: /rest/api/v1.3/attributes/programs/{programName}
Fetch all organizations: Method: get
Path: /rest/api/v1.3/attributes/organizations
Update a campaign's organizational access: Method: post
Path: /rest/api/v1.3/attributes/campaigns/{campaignName}
Update a program's organizational access: Method: post
Path: /rest/api/v1.3/attributes/programs/{programName}

Profile Extension Recipients

One or more Recipients within a Profile Extension Table in the Responsys Interact Suite.

Delete multiple Profile Extension Recipients: Method: post
Path: /rest/api/v1.3/lists/{listName}/listExtensions/{petName}/members
Delete Profile Extension Recipient using an RIID: Method: delete
Path: /rest/api/v1.3/lists/{listName}/listExtensions/{petName}/members/{riid}
Merge Profile Extension Recipients: Method: post
Path: /rest/api/v1.3/lists/{listName}/listExtensions/{petName}/members
Retrieve Multiple Profile Extension Recipients: Method: post
Path: /rest/api/v1.3/lists/{listName}/listExtensions/{petName}/members
Retrieve Profile Extension Recipient using a query attribute: Method: get
Path: /rest/api/v1.3/lists/{listName}/listExtensions/{petName}/members
Retrieve Profile Extension Recipient using an RIID: Method: get
Path: /rest/api/v1.3/lists/{listName}/listExtensions/{petName}/members/{riid}

Profile List Recipients

One or more Recipients within a Profile List in the Responsys Interact Suite.

Delete List Recipients based on RIID: Method: delete
Path: /rest/api/v1.3/lists/{listName}/members/{riid}
Delete multiple Profile List Recipients: Method: post
Path: /rest/api/v1.3/lists/{listName}/members
Delete Profile List Recipients using query attribute: Method: delete
Path: /rest/api/v1.3/lists/{listName}/members
Merge List Recipients: Method: post
Path: /rest/api/v1.3/lists/{listName}/members
Retrieve List Recipient using query attribute: Method: get
Path: /rest/api/v1.3/lists/{listName}/members
Retrieve List Recipient using RIID: Method: get
Path: /rest/api/v1.3/lists/{listName}/members/{riid}
Retrieve List Recipients Count using query attribute: Method: get
Path: /rest/api/v1.3/lists/{listName}/members/count
Retrieve multiple Profile List Recipients: Method: post
Path: /rest/api/v1.3/lists/{listName}/members

Profile Lists

Profile Lists in the Responsys Interact Suite

Add or Update RIID in the Organizational Scope Mapping: Method: put
Path: /rest/api/v1.3/lists/{listName}/orgListExtensions/members
Create a Profile List with or without brand Context: Method: post
Path: /rest/api/v1.3/lists
Fetch All Profile Lists: Method: get
Path: /rest/api/v1.3/lists
Retrieve Profile List Fields: Method: get
Path: /rest/api/v1.3/lists/{listName}/fields
Retrieve Proof Lists: Method: get
Path: /rest/api/v1.3/lists/proofLists/records
Retrieve Segment Groups: Method: get
Path: /rest/api/v1.3/lists/segmentGroups/records

Programs

Responsys Program API Endpoints

Exit Enactments: Method: post
Path: /rest/api/v1.3/programs/enactments
Fetch a Program by Name: Method: get
Path: /rest/api/v1.3/programs/{programName}
Fetch All Programs: Method: get
Path: /rest/api/v1.3/programs
Fetch Programs for a Profile List: Method: get
Path: /rest/api/v1.3/programs/lists/{listName}
Publish or Unpublish a Program: Method: patch
Path: /rest/api/v1.3/programs/{programName}

Supplemental Table Members

Members of a Supplemental Data Table in the Responsys Interact Suite.

Delete Supplemental Table member based on a query attribute: Method: delete
Path: /rest/api/v1.3/folders/{folderName}/suppData/{tableName}/members
Fetch all the fields or the primary key fields of the Supplemental Table: Method: get
Path: /rest/api/v1.3/folder/{folderName}/suppData/{suppTableName}
Merge Supplemental Table members with PK: Method: post
Path: /rest/api/v1.3/folders/{folderName}/suppData/{tableName}/members
Merge Table Records: Method: post
Path: /rest/api/v1.3/folders/{folderName}/suppData/{tableName}/members
Retrieve Supplemental Table member based on a query attribute: Method: get
Path: /rest/api/v1.3/folders/{folderName}/suppData/{tableName}/members

Supplemental Tables

Supplemental table objects.

Create Supplemental Table: Method: post
Path: /rest/api/v1.3/folders/{folderName}/suppData
Fetch All Supplemental Tables: Method: get
Path: /rest/api/v1.3/suppData
Update Supplemental Table: Method: put
Path: /rest/api/v1.3/folders/{folderName}/suppData/{suppTableName}

Trigger Email Message

Send Responsys Email Campaigns to existing members of a Profile List.

Trigger Email Message: Method: post
Path: /rest/api/v1.3/campaigns/{campaignName}/email

Trigger Push Message

Send Responsys Push Campaigns to existing members of a Profile List

Trigger Push Message: Method: post
Path: /rest/api/v1.3/campaigns/{campaignName}/push

Trigger SMS Message

Trigger SMS messages to existing members of a profile list.

Trigger SMS Message: Method: post
Path: /rest/api/v1.3/campaigns/{campaignName}/sms/trigger