Contacts
Used to access Contacts and their related Interactions
| Method | URL | Description |
|---|---|---|
| GET | contacts/{contactId} |
Get the details for a specific contact |
| GET | contacts/{contactId}/campaigns |
Get a list of a Contact's Campaigns |
| GET | contacts/{contactId}/communications |
Get all Communications a Contact has had with the Platform |
| GET | contacts/{contactId}/campaignactivities/{campaignId} |
Get all interactions a Contact has in a given Campaign |
| GET | contacts/{contactId}/summary |
Get the last 10 Emails, Texts, LandingPages, WebForms, RSVPEvents and Competitions interactions this Contact has had with the Platform |
| GET | contacts/{contactId}/emails |
Get a list of a Contact's Email Interactions |
| GET | contacts/{contactId}/textmessages |
Get a list of a Contact's TextMessage Interactions |
| GET | contacts/{contactId}/landingpages |
Get a list of a Contact's Landing Page Interactions |
| GET | contacts/{contactId}/webforms |
Get a list of a Contact's WebForm Interactions |
| GET | contacts/{contactId}/rsvpevents |
Get a list of a Contact's RSVP Event Interactions |
| GET | contacts/{contactId}/competitions |
Get a list of a Contact's Competition Interactions |
Campaigns
Used to access Campaigns and related Reports/Activities
| Method | URL | Description |
|---|---|---|
| GET | campaigns |
Get a List of Campaigns |
| GET | campaigns/{campaignId} |
Get the details of a specific Campaign |
| GET | campaigns/{campaignId}/contacts |
Get a list of Contacts for a specific Campaign |
| GET | campaigns/{campaignId}/reports |
Get channel reports for a specific Campaign |
| GET | campaigns/{campaignId}/reports/emails |
Get an Emails Report for a specific Campaign |
| GET | campaigns/{campaignId}/reports/emails/{emailId}/contacts |
Get all Contacts from a given Campaign who where sent a specific Email. |
| GET | campaigns/{campaignId}/reports/emails/{emailId}/contacts/{state} |
Get all Contacts from a given Campaign who where sent a given email which is at a specified State |
| GET | campaigns/{campaignId}/reports/textmessages |
Get a TextMessages Report for a specific Campaign |
| GET | campaigns/{campaignId}/reports/textmessages/{textMessageId}/contacts |
Get all Contacts from a given Campaign who where sent a specific TextMessage. |
| GET | campaigns/{campaignId}/reports/textmessages/{textMessageId}/contacts/{state} |
Get all Contacts from a given Campaign who where sent a given TextMessage - which is at a specified State |
| GET | campaigns/{campaignId}/reports/rsvpevent |
Get an RSVPEvents Report for a specific Campaign |
| GET | campaigns/{campaignId}/reports/rsvpevent/{rsvpEventId}/contacts |
Get all Contacts from a given Campaign who were part of a specifc RSVP Event. |
| GET | campaigns/{campaignId}/reports/rsvpevent/{rsvpEventId}/contacts/{state} |
Get all Contacts from a given Campaign who were part of a specifc RSVP Event - who's invitation is in a specific state |
| GET | campaigns/{campaignId}/reports/landingpages |
Get a LandingPages Report for a specific Campaign |
| GET | campaigns/{campaignId}/reports/landingpages/{landingpageId}/contacts |
Get all Contacts from a given Campaign who visited a specific Landing Page |
| GET | campaigns/{campaignId}/reports/landingpages/{landingpageId}/contacts/{state} |
Get all Contacts from a given Campaign who visited a specific Landing Page by their state in it's workflow |
| GET | campaigns/{campaignId}/reports/competitions |
Get a Competitions Report for a specific Campaign |
| GET | campaigns/{campaignId}/reports/competitions/{competitionId}/contacts |
Get all Contacts from a given Campaign involved with a specific Competition |
| GET | campaigns/{campaignId}/reports/competitions/{competitionId}/contacts/{state} |
Get all Contacts from a given Campaign involved with a specific Competition by their state in it's workflow |
| GET | campaigns/{campaignId}/activities |
Get a list of Activities for a given campaign |
| GET | campaigns/{campaignId}/activities/{activityId} |
Get a specific Activity for a given Campaign |
| GET | campaigns/{campaignId}/activities/{activityId}/contacts |
Get a list of Contacts who participated in a specific Campaign Activity |
| POST | campaigns/{campaignId}/landingpages/{landingpageId}/generatePDF |
Create/Update a contact in a specific ContactList |
ContactLists
Used to View ContactList Contacts, Schemas/Fields, as well as insert/update contacts
| Method | URL | Description |
|---|---|---|
| GET | contactLists |
Gets a list of ContactLists |
| GET | contactLists/{contactListId} |
Get a specific ContactList |
| GET | contactLists/{contactListId}/fields |
Get a specific ContactList's fields |
| GET | contactLists/{contactListId}/fields/{fieldId} |
Get the details of a specific ContactList's Field |
| GET | contactLists/{contactListId}/campaigns |
Get a list of Campaigns that use a specific ContactList |
| GET | contactLists/{contactListId}/contacts |
Get a list of Contacts for a specific ContactList |
| PATCH | contactLists/{contactListId}/contact |
Find all contacts within a given contactlist that match a set of values, then update their properties to given values E.G. Find all contacts with an ReferanceAccountID of 123456 and set their address to "123 Red Street, D1". |
| POST | contactLists/{contactListId}/contact |
Create/Update a contact in a specific ContactList |
| POST | contactLists/{contactListId}/import |
Create an Import job for a specific ContactList |
| GET | contactLists/{contactListId}/import/{importJobId} |
Check the status of an Import Job belonging to a specific ContactList |
| POST | contactLists/{contactListId}/import/{importJobId} |
Insert/Update a batch of Contacts in a specific Import Job belonging to a specific Contact List |
| POST | contactLists/{contactListId}/import/{importJobId}/run |
Run an ImportJob for a specific ContactList, to start the batch Insert/Update process |
| GET | contactLists/{contactListId}/linkeddata |
Get a list of Linked Data for a specific contact list |
| GET | contactLists/{contactListId}/linkeddata/{linkedDataId} |
Get a specific Linked Data from a specific contact list |
| GET | contactLists/{contactListId}/linkeddata/{linkedDataId}/fields |
Get a specific Linked Data schema's fields from a specific ContactList |
| GET | contactLists/{contactListid}/linkeddata/{linkedDataId}/fields/{fieldId} |
Get the details of a specific Linked Data schema's Field |
| GET | contactLists/{listId}/linkeddata/{linkedDataId}/records |
Get a specific set of Linked Data's records from a specific ContactList |
Files
Used to manage files in the FTP folder
| Method | URL | Description |
|---|---|---|
| GET | files?filePath={filePath} |
Gets and returns a file as specified by the filePath parameter |
| POST | files?subFolder={subFolder} |
Upload a file to the specified subFolder. The file must be attached as a Form-data value |
| DELETE | files?filePath={filePath}&download={download} |
Deletes the file as specified by the filePath parameter. |
Events
Use to access Events and related Attendence and Reports
| Method | URL | Description |
|---|---|---|
| GET | events |
Get a List of Events |
| GET | events/{eventId} |
Get the details of a specific Event |
| GET | events/{eventId}/attendances |
Get a list of attendance for a specific Event |
| POST | events/{eventId}/attendances |
Create an EventAttendance Record for a specific event |
| PUT | events/{eventId}/attendances/{eventAttendanceId} |
Update a specific EventAttendance Record for a specific Event |
| POST | events/{eventId}/register/{encContactId} |
Mark a Contact as having registered for a specific Event |
| POST | events/{eventId}/unregister/{encContactId} |
Mark a Contact as having unregistered for a specific Event |
| POST | events/{eventId}/confirm/{encContactId} |
Mark a Contact as having confirmed their attendance at a specific Event |
| POST | events/{eventId}/decline/{encContactId} |
Mark a Contact as having declined to attend a specific Event |
| POST | events/{eventId}/attend/{encContactId} |
Mark a Contact as having attended a specific Event |
Accounts
Used to Log-in and log-out, as well as see User Account Info
| Method | URL | Description |
|---|---|---|
| GET | accounts |
Gets account info for a logged-in/authenticated User |
| POST | accounts/login?verificationCode={verificationCode} |
Logs in the requesting User |
| GET | accounts/logout |
Logs out the requesting User |
| POST | accounts/users/apps |
Get a list of available app for a given user |
| GET | accounts/getCustomEvents |
Gets account info for a logged-in/authenticated User |
| GET | accounts/appConfig |
Gets App config for a logged-in/authenticated User |
| POST | accounts/users/setPassword |
Gets App config for a logged-in/authenticated User |
| GET | accounts/users |
Gets App config for a logged-in/authenticated User |
| POST | accounts/users |
Creates a new User record |
| POST | accounts/users/sendPasswordResetEmail |
Creates a new User record |
| PUT | accounts/users |
Updates the User |