| Authenticate Using Username and Password |
POST /rest/api/v1.3/auth/token
|
Set auth_type=password and password=<PASSWORD>. |
| Logout |
N/A |
No logout API call, automatically logged out after 2 hours. |
| AuthenticateServer |
POST /rest/api/v1.3/auth/token
|
Set auth_type=server and client_challenge=<CLIENT_CHALLENGE_VALUE>. |
|
LoginWithCertificate |
POST /rest/api/v1.3/auth/token
|
Set auth_type=server and client_challenge=<CLIENT_CHALLENGE_VALUE>. |
| CreateContentLibraryFolder |
POST /rest/api/v1.3/clFolders
|
|
| CreateFolder
|
POST /rest/api/v1.3/folders
|
|
| DeleteContentLibraryFolder
|
DELETE /rest/api/v1.3/clFolders
|
|
| DeleteFolder
|
N/A |
There is currently no REST API to delete a folder. |
| DoesContentLibraryFolderExist
|
GET /rest/api/v1.3/clFolders/{folderPath}
|
Will provide an error message if folder does not exist. |
| ListContentLibraryFolders
|
GET /rest/api/v1.3/clFolders/{folderPath}
|
To get the objects at the root level (that is, for the entire account), replace the folderPath parameter with the value contentlibrary. |
| ListFolders |
GET /rest/api/v1.3/folders
|
|
| MergeListMembers
|
POST /rest/api/v1.3/lists/{listName}/members
|
|
| MergeListMembersRIID
|
POST /rest/api/v1.3/lists/{listName}/members
|
Use RIID as the matchColumnName field |
| DeleteListMembers
|
POST /rest/api/v1.3/lists/{listName}/members?action=delete
|
|
| RetrieveListMembers |
POST /rest/api/v1.3/lists/{listName}/members?action=get
|
|
| CreateProfileExtensionTable
|
POST /rest/api/v1.3/lists/{listName}/listExtensions |
|
| CreateTable
|
POST /rest/api/v1.3/folders/{folderName}/suppData
|
|
| CreateTableWithPK
|
POST /rest/api/v1.3/folders/{folderName}/suppData
|
Add the primary keys in the request body. |
| DeleteProfileExtensionMembers |
POST /rest/api/v1.3/lists/{listName}/listExtensions/{petName}/members?action=delete |
|
|
DeleteTable
|
DELETE /rest/api/v1.3/folders/{folderName}/suppData/{suppTableName}/table
|
|
| MergeIntoProfileExtension
|
POST /rest/api/v1.3/lists/{listName}/listExtensions/{petName}/members
|
|
| MergeTableRecords
|
POST /rest/api/v1.3/folders/{folderName}/suppData/{tableName}/members
|
|
| MergeTableRecordsWithPK
|
POST /rest/api/v1.3/folders/{folderName}/suppData/{tableName}/members
|
|
| DeleteTableRecords
|
DELETE /rest/api/v1.3/folders/{folderName}/suppData/{tableName}/members
|
|
| RetrieveTableRecords
|
GET /rest/api/v1.3/folders/{folderName}/suppData/{tableName}/members
|
|
| RetrieveProfileExtensionRecords |
GET /rest/api/v1.3/lists/{listName}/listExtensions/{petName}/members/{riid}
|
|
| TruncateTable |
DELETE /rest/api/v1.3/folders/{folderName}/suppData/{tableName}/members
|
|
| CopyContentLibraryItem
|
PUT /rest/api/v1.3/clItems/{destinationItemPath}
|
|
| CreateContentLibraryItem
|
POST /rest/api/v1.3/clItems |
|
| CreateDocument
|
POST /rest/api/v1.3/clDocs
|
|
| DeleteContentLibraryItem |
DELETE /rest/api/v1.3/clItems/{itemPath}
|
|
| DeleteDocument
|
DELETE /rest/api/v1.3/clDocs/{docPath}
|
|
| GetContentLibraryItem
|
GET /rest/api/v1.3/clItems/{itemPath} |
|
| GetDocumentContent
|
GET /rest/api/v1.3/clDocs/{docPath}
|
|
| GetDocumentImages
|
GET /rest/api/v1.3/clDocImages/{documentPath} |
|
| MoveContentLibraryItem
|
N/A |
Call the copy API and then call the delete API on the original. |
| SetDocumentContent
|
PUT /rest/api/v1.3/clDocs/{docPath}
|
|
| SetDocumentImages
|
POST /rest/api/v1.3/clDocImages/{documentPath}
|
|
| UpdateContentLibraryItem |
PUT /rest/api/v1.3/clItems/{itemPath}
|
|
| GetLaunchStatus
|
GET /rest/api/v1.3/campaigns/{campaignName}/schedule
|
Will retrieve all schedules, including currently launched schedules. |
| LaunchCampaign
|
POST /rest/api/v1.3/campaigns/{campaignName}/schedule
|
Set scheduleType to "NOW" to launch the campaign immediately. |
| MergeTriggerEmail
|
POST /rest/api/v1.3/campaigns/{campaignName}/email
|
|
| MergeTriggerSMS
|
POST /rest/api/v1.3/campaigns/{campaignName}/sms
|
|
| ScheduleCampaignLaunch
|
POST /rest/api/v1.3/campaigns/{campaignName}/schedule
|
|
| TriggerCustomEvent
|
POST /rest/api/v1.3/events/{eventName}
|
|
| TriggerCampaignMessage |
POST /rest/api/v1.3/campaigns/{campaignName}/email
|
|