Operations at http://studio.mdl.io/REST/contactservice

This page describes the service operations at this endpoint.

Uri	Method	Description
CancelImport	POST	To cancel a submitted import. As processing an import task may takes some time, by using this call, you have a chance to cancel the operation.
ContactExport	POST	To export contact data in the provided scope.
ConvertContactID	POST	To convert Contact ID to Contact DataWarecouse ID and Vice Versa.
CreateContact	POST	To add a new contact by providing a list of key/value pairs. The keys are contact field names.
CreateContactByPartner	POST	To add a new contact by providing a list of key/value pairs. The keys are contact field names.
GetAcceptedDataListCsv	POST	To get the CSV file of accepted records of a selected Data List
GetContactActivities	POST	To get a list of a specific user's activities during a time period for a desired program. It returns a zipped CSV file.
GetContactActivitiesByPage	POST	To get a list of a specific user's activities during a time period for a desired program. It returns a zipped CSV file.
GetContactFieldList	POST	To get a list of all fields avaiable for contacts. You can specify what type of fields you want: 0=both standard and custom fields, 1=only standard fields and 2=only custom fields. DataType_ID can be: 1=String, 2=Integer, 3=Decimal, 4=DateTime, 5=Boolean
GetContactInfo	POST	To get summary information about the contact
GetContactList	POST	To get a list of all or a subset of contacts. You can specify the fields you are interested in. The OutputType should always be zero (zipped CSV).
GetContactListById	POST	To get contacts details by providing their (account) IDs. You can specify an array of field names as well as contact IDs. OutputType should be zero for zipped CSV.
GetContactListCount	POST	To get the number of contacts for the specified contacts through filter property.
GetContactsByPage	POST	To get a list of all or a subset of contacts. You can specify the fields you are interested in and page number.
GetDataListCsv	POST	To get the original Data List CSV file.
GetDataLists	POST	To get the list of all uploaded Data Lists
GetDWContactFieldList	POST	To get a list of all fields avaiable for contacts from Data Warehouse. You can specify what type of fields you want: 0=both standard and custom fields, 1=only standard fields and 2=only custom fields. DataType_ID can be: 1=String, 2=Integer, 3=Decimal, 4=DateTime, 5=Boolean
GetImportList	POST	To get a list of all imports submitted to the system. It returns an array of imports with all related details [Mode: 1=insert/update, 2=insert only, 3=update only, 4=inactivate, 5=activate], [Status: 0=waiting for process, 1=in process, 2=complete, 3=failed, 4=cancelled, 255=all]
GetImportListCount	POST	To get the number of submitted imports. NOTE: This is not the number of contacts but only the count for number of batches that have been processed [Status: 0=waiting for process, 1=in process, 2=complete, 3=failed, 4=cancelled, 255=all]
GetImportLog	POST	To get the import log for a specific import. It returns a CSV file with all the invalid records [OutputType: 0=zipped CSV]
GetImportNames	POST	To get a list of all import Names submitted to the system.
GetInactiveContacts	POST	To get a list of all inactive contacts (Only purl field).
GetLifetimeScore	POST	To get the Lifetime Score of requested contact.
ImportContacts	POST	To import contacts through a CSV file for an action. The action can be one of Add, Update, Add/Update, Activate or Inactivate [Mode: 1=insert/update, 2=insert only, 3=update only, 4=inactivate, 5=activate], [Status: 0=waiting for process, 1=in process, 2=complete, 3=failed, 4=cancelled, 255=all]
ImportContactsByPartner	POST	To import contacts through a CSV file for an action. The action can be one of Add, Update, Add/Update, Activate or Inactivate [Mode: 1=insert/update, 2=insert only, 3=update only, 4=inactivate, 5=activate], [Status: 0=waiting for process, 1=in process, 2=complete, 3=failed, 4=cancelled, 255=all]
PersistReservationIDList	POST	To persist Outbound Contact Reservation IDs in case of DataList used in Schedule
ScheduleContactExport	POST	To export contact data in the provided scope.
SetContactField	POST	To add a contact field. This can be a standard (Type=1) or custom (Type=2) field. The data type of the field can be: 1=String, 2=Integer, 3=Decimal, 4=DateTime, 5=Boolean
ToggleDataListFilterable	POST	To allow changing the filterable option of a specific DataList. When a DataList is uploaded, you can specify if the DataList should be appeard in the schedule DataLists dropdown.
ToggleImportFilterable	POST	To allow changing the filterable option of a specific import. When a file is imported, you can specify if the import name should be appeard in the list, when campaign designer wants to filter contacts based on importname, or not.
Unsubscribe	POST	To unsubscribe a user from receiving emails or text messages, etc, through campaign programs. The required information in the request should be collected from the link that is sent after the user clicks on unsubscribe link.
UpdateContact	POST	To update an existing contact information by providing a list of key/value pairs. The keys are contact field names.
UpdateContactByPartner	POST	To update a contact by providing contact id or outbound contact id and a list of key/value pairs. The keys are contact field names.
UploadDataList	POST	To upload a Data List to use in OutboundCentric schedules
UploadDataListByPartner	POST	To upload a Data List to use in OutboundCentric schedules
UploadZippedDataList	POST	To upload a Zipped Data List to use in OutboundCentric schedules
UploadZippedDataListByPartner	POST	To upload a Zipped Data List to use in OutboundCentric schedules
ValidateImport	POST	To Validate Contacts Import Before Import API Call.
ValidateImportName	POST	Validate contact import name.