API

ProFundCom API Documentation

An example of how to use the ProFundCom API is below:
	
	
	
            PFCApiConnector.Initialise();

            String exampleEMailAddress="alan@burrist.co.uk";
            
            // create a miling list
            Mailing_list mailing_list = new Mailing_list();
            mailing_list.mailing_list_name = "test 123";
            if(mailing_list.save())
            {
                //store the id
                String mailing_list_id = mailing_list.id;

                // get the mailing list (just to demonstrate - we already have it)
                Mailing_list retrieved_mailing_list = Mailing_list.getByID(mailing_list_id);

                //update the mailing list
                retrieved_mailing_list.mailing_list_name = "test 234";
                retrieved_mailing_list.save();

                // create a member
                Mailing_list_member mailing_list_member = new Mailing_list_member();
                mailing_list_member.mailing_list_id = retrieved_mailing_list.mailing_list_id;
                mailing_list_member.email = exampleEMailAddress;
                if (mailing_list_member.save())
                {
                    //get all of the members of this list
                    List mailing_list_members=retrieved_mailing_list.getChildMailing_list_members();
                    //and now delete it
                    mailing_list_member.delete();
                }
                // and the list
                retrieved_mailing_list.delete();
            }

            // create a contact
            Contact contact = new Contact();
            contact.email = exampleEMailAddress;
            if (contact.save())
            {
                //store the id
                String contact_id = contact.id;
                //get a list of contacts with this email - just to demostrate query string usage
                List contacts = Contact.getAll("?email=" + exampleEMailAddress);
                // get the contact(just to demonstrate - we already have it)
                Contact retrieved_contact = Contact.getByID(contact_id);
                //and now delete it
                retrieved_contact.delete();
            }

            //get some transactions and emails

            String dateLimit = DateTime.Now.AddDays(-30).ToString("yyyy-MM-dd");
            List email_sents = Email_sent.getAll("?Email=" + exampleEMailAddress);
            List view_website_activitys = View_website_activity.getAll("?DateAfter=" + dateLimit);
            List view_campaign_all_emails = View_campaign_all_email.getAll("?DateAfter=" + dateLimit + "&Email=" + exampleEMailAddress);
            List view_campaign_responds = View_campaign_respond.getAll("?DateAfter=" + dateLimit);
            List view_campaign_respond_links = View_campaign_respond_links.getAll("?DateAfter=" + dateLimit);

activity_by_city

activity_by_city number of engagments by geographical region in the last month

Requesting Data

The ProFundCom API supports requests for activity_by_city data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of activity_by_city entities .
GET http://[root url]/activity_by_city
Response Payload
{
    "data":[   
                {
                "Country":"[Country value 1]"                
                ,"country_code":"[country_code value 1]"                
                ,"total":"[total value 1]"                
                ,"total_unique":"[total_unique value 1]"                
                ,"lat":"[lat value 1]"                
                ,"long":"[long value 1]"                
                ,"City":"[City value 1]"                
    
                },
......
                {
                "Country":"[Country value n]"                
                ,"country_code":"[country_code value n]"                
                ,"total":"[total value n]"                
                ,"total_unique":"[total_unique value n]"                
                ,"lat":"[lat value n]"                
                ,"long":"[long value n]"                
                ,"City":"[City value n]"                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • TXType
  • ID
  • Email
  • ^ID
For example
GET http://[root url]/activity_by_city?TXType=A%20filter%20value

activity_by_country

activity_by_country number of engagments by geographical region in the last month

Requesting Data

The ProFundCom API supports requests for activity_by_country data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of activity_by_country entities .
GET http://[root url]/activity_by_country
Response Payload
{
    "data":[   
                {
                "Country":"[Country value 1]"                
                ,"country_code":"[country_code value 1]"                
                ,"total":"[total value 1]"                
                ,"total_unique":"[total_unique value 1]"                
                ,"lat":"[lat value 1]"                
                ,"long":"[long value 1]"                
    
                },
......
                {
                "Country":"[Country value n]"                
                ,"country_code":"[country_code value n]"                
                ,"total":"[total value n]"                
                ,"total_unique":"[total_unique value n]"                
                ,"lat":"[lat value n]"                
                ,"long":"[long value n]"                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • TXType
  • ID
  • Email
  • ^ID
For example
GET http://[root url]/activity_by_country?TXType=A%20filter%20value

ap_forms

ap_forms ...

Requesting Data

The ProFundCom API supports requests for ap_forms data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of ap_forms entities .
GET http://[root url]/ap_forms
Response Payload
{
    "data":[   
                {
                "form_id":"[form_id value 1]"                
                ,"form_name":"[form_name value 1]"                
                ,"form_description":"[form_description value 1]"                
                ,"form_email":"[form_email value 1]"                
                ,"form_redirect":"[form_redirect value 1]"                
                ,"form_success_message":"[form_success_message value 1]"                
                ,"form_password":"[form_password value 1]"                
                ,"form_unique_ip":"[form_unique_ip value 1]"                
                ,"form_frame_height":"[form_frame_height value 1]"                
                ,"form_has_css":"[form_has_css value 1]"                
                ,"form_captcha":"[form_captcha value 1]"                
                ,"form_active":"[form_active value 1]"                
                ,"form_review":"[form_review value 1]"                
                ,"esl_from_name":"[esl_from_name value 1]"                
                ,"esl_from_email_address":"[esl_from_email_address value 1]"                
                ,"esl_subject":"[esl_subject value 1]"                
                ,"esl_content":"[esl_content value 1]"                
                ,"esl_plain_text":"[esl_plain_text value 1]"                
                ,"esr_email_address":"[esr_email_address value 1]"                
                ,"esr_from_name":"[esr_from_name value 1]"                
                ,"esr_from_email_address":"[esr_from_email_address value 1]"                
                ,"esr_subject":"[esr_subject value 1]"                
                ,"esr_content":"[esr_content value 1]"                
                ,"esr_plain_text":"[esr_plain_text value 1]"                
                ,"form_tags":"[form_tags value 1]"                
                ,"form_redirect_enable":"[form_redirect_enable value 1]"                
                ,"form_captcha_type":"[form_captcha_type value 1]"                
                ,"form_theme_id":"[form_theme_id value 1]"                
                ,"form_resume_enable":"[form_resume_enable value 1]"                
                ,"form_limit_enable":"[form_limit_enable value 1]"                
                ,"form_limit":"[form_limit value 1]"                
                ,"form_label_alignment":"[form_label_alignment value 1]"                
                ,"form_language":"[form_language value 1]"                
                ,"form_page_total":"[form_page_total value 1]"                
                ,"form_lastpage_title":"[form_lastpage_title value 1]"                
                ,"form_submit_primary_text":"[form_submit_primary_text value 1]"                
                ,"form_submit_secondary_text":"[form_submit_secondary_text value 1]"                
                ,"form_submit_primary_img":"[form_submit_primary_img value 1]"                
                ,"form_submit_secondary_img":"[form_submit_secondary_img value 1]"                
                ,"form_submit_use_image":"[form_submit_use_image value 1]"                
                ,"form_review_primary_text":"[form_review_primary_text value 1]"                
                ,"form_review_secondary_text":"[form_review_secondary_text value 1]"                
                ,"form_review_primary_img":"[form_review_primary_img value 1]"                
                ,"form_review_secondary_img":"[form_review_secondary_img value 1]"                
                ,"form_review_use_image":"[form_review_use_image value 1]"                
                ,"form_review_title":"[form_review_title value 1]"                
                ,"form_review_description":"[form_review_description value 1]"                
                ,"form_pagination_type":"[form_pagination_type value 1]"                
                ,"form_schedule_enable":"[form_schedule_enable value 1]"                
                ,"form_schedule_start_date":"[form_schedule_start_date value 1]"                
                ,"form_schedule_end_date":"[form_schedule_end_date value 1]"                
                ,"form_schedule_start_hour":"[form_schedule_start_hour value 1]"                
                ,"form_schedule_end_hour":"[form_schedule_end_hour value 1]"                
                ,"esl_enable":"[esl_enable value 1]"                
                ,"esr_enable":"[esr_enable value 1]"                
                ,"payment_enable_merchant":"[payment_enable_merchant value 1]"                
                ,"payment_merchant_type":"[payment_merchant_type value 1]"                
                ,"payment_paypal_email":"[payment_paypal_email value 1]"                
                ,"payment_paypal_language":"[payment_paypal_language value 1]"                
                ,"payment_currency":"[payment_currency value 1]"                
                ,"payment_show_total":"[payment_show_total value 1]"                
                ,"payment_total_location":"[payment_total_location value 1]"                
                ,"payment_enable_recurring":"[payment_enable_recurring value 1]"                
                ,"payment_recurring_cycle":"[payment_recurring_cycle value 1]"                
                ,"payment_recurring_unit":"[payment_recurring_unit value 1]"                
                ,"payment_price_type":"[payment_price_type value 1]"                
                ,"payment_price_amount":"[payment_price_amount value 1]"                
                ,"payment_price_name":"[payment_price_name value 1]"                
                ,"logic_field_enable":"[logic_field_enable value 1]"                
                ,"logic_page_enable":"[logic_page_enable value 1]"                
                ,"payment_enable_trial":"[payment_enable_trial value 1]"                
                ,"payment_trial_period":"[payment_trial_period value 1]"                
                ,"payment_trial_unit":"[payment_trial_unit value 1]"                
                ,"payment_trial_amount":"[payment_trial_amount value 1]"                
                ,"payment_stripe_live_secret_key":"[payment_stripe_live_secret_key value 1]"                
                ,"payment_stripe_live_public_key":"[payment_stripe_live_public_key value 1]"                
                ,"payment_stripe_test_secret_key":"[payment_stripe_test_secret_key value 1]"                
                ,"payment_stripe_test_public_key":"[payment_stripe_test_public_key value 1]"                
                ,"payment_stripe_enable_test_mode":"[payment_stripe_enable_test_mode value 1]"                
                ,"payment_paypal_enable_test_mode":"[payment_paypal_enable_test_mode value 1]"                
                ,"payment_enable_invoice":"[payment_enable_invoice value 1]"                
                ,"payment_invoice_email":"[payment_invoice_email value 1]"                
                ,"payment_delay_notifications":"[payment_delay_notifications value 1]"                
                ,"payment_ask_billing":"[payment_ask_billing value 1]"                
                ,"payment_ask_shipping":"[payment_ask_shipping value 1]"                
                ,"form_disabled_message":"[form_disabled_message value 1]"                
                ,"payment_enable_tax":"[payment_enable_tax value 1]"                
                ,"payment_tax_rate":"[payment_tax_rate value 1]"                
                ,"logic_email_enable":"[logic_email_enable value 1]"                
                ,"payment_enable_discount":"[payment_enable_discount value 1]"                
                ,"payment_discount_type":"[payment_discount_type value 1]"                
                ,"payment_discount_amount":"[payment_discount_amount value 1]"                
                ,"payment_discount_code":"[payment_discount_code value 1]"                
                ,"payment_discount_element_id":"[payment_discount_element_id value 1]"                
                ,"payment_discount_max_usage":"[payment_discount_max_usage value 1]"                
                ,"payment_discount_expiry_date":"[payment_discount_expiry_date value 1]"                
                ,"webhook_enable":"[webhook_enable value 1]"                
                ,"webhook_url":"[webhook_url value 1]"                
                ,"webhook_method":"[webhook_method value 1]"                
                ,"payment_paypal_rest_live_clientid":"[payment_paypal_rest_live_clientid value 1]"                
                ,"payment_paypal_rest_live_secret_key":"[payment_paypal_rest_live_secret_key value 1]"                
                ,"payment_paypal_rest_test_clientid":"[payment_paypal_rest_test_clientid value 1]"                
                ,"payment_paypal_rest_test_secret_key":"[payment_paypal_rest_test_secret_key value 1]"                
                ,"payment_paypal_rest_enable_test_mode":"[payment_paypal_rest_enable_test_mode value 1]"                
                ,"payment_authorizenet_live_apiloginid":"[payment_authorizenet_live_apiloginid value 1]"                
                ,"payment_authorizenet_live_transkey":"[payment_authorizenet_live_transkey value 1]"                
                ,"payment_authorizenet_test_apiloginid":"[payment_authorizenet_test_apiloginid value 1]"                
                ,"payment_authorizenet_test_transkey":"[payment_authorizenet_test_transkey value 1]"                
                ,"payment_authorizenet_enable_test_mode":"[payment_authorizenet_enable_test_mode value 1]"                
                ,"payment_authorizenet_save_cc_data":"[payment_authorizenet_save_cc_data value 1]"                
                ,"payment_braintree_live_merchant_id":"[payment_braintree_live_merchant_id value 1]"                
                ,"payment_braintree_live_public_key":"[payment_braintree_live_public_key value 1]"                
                ,"payment_braintree_live_private_key":"[payment_braintree_live_private_key value 1]"                
                ,"payment_braintree_live_encryption_key":"[payment_braintree_live_encryption_key value 1]"                
                ,"payment_braintree_test_merchant_id":"[payment_braintree_test_merchant_id value 1]"                
                ,"payment_braintree_test_public_key":"[payment_braintree_test_public_key value 1]"                
                ,"payment_braintree_test_private_key":"[payment_braintree_test_private_key value 1]"                
                ,"payment_braintree_test_encryption_key":"[payment_braintree_test_encryption_key value 1]"                
                ,"payment_braintree_enable_test_mode":"[payment_braintree_enable_test_mode value 1]"                
    
                },
......
                {
                "form_id":"[form_id value n]"                
                ,"form_name":"[form_name value n]"                
                ,"form_description":"[form_description value n]"                
                ,"form_email":"[form_email value n]"                
                ,"form_redirect":"[form_redirect value n]"                
                ,"form_success_message":"[form_success_message value n]"                
                ,"form_password":"[form_password value n]"                
                ,"form_unique_ip":"[form_unique_ip value n]"                
                ,"form_frame_height":"[form_frame_height value n]"                
                ,"form_has_css":"[form_has_css value n]"                
                ,"form_captcha":"[form_captcha value n]"                
                ,"form_active":"[form_active value n]"                
                ,"form_review":"[form_review value n]"                
                ,"esl_from_name":"[esl_from_name value n]"                
                ,"esl_from_email_address":"[esl_from_email_address value n]"                
                ,"esl_subject":"[esl_subject value n]"                
                ,"esl_content":"[esl_content value n]"                
                ,"esl_plain_text":"[esl_plain_text value n]"                
                ,"esr_email_address":"[esr_email_address value n]"                
                ,"esr_from_name":"[esr_from_name value n]"                
                ,"esr_from_email_address":"[esr_from_email_address value n]"                
                ,"esr_subject":"[esr_subject value n]"                
                ,"esr_content":"[esr_content value n]"                
                ,"esr_plain_text":"[esr_plain_text value n]"                
                ,"form_tags":"[form_tags value n]"                
                ,"form_redirect_enable":"[form_redirect_enable value n]"                
                ,"form_captcha_type":"[form_captcha_type value n]"                
                ,"form_theme_id":"[form_theme_id value n]"                
                ,"form_resume_enable":"[form_resume_enable value n]"                
                ,"form_limit_enable":"[form_limit_enable value n]"                
                ,"form_limit":"[form_limit value n]"                
                ,"form_label_alignment":"[form_label_alignment value n]"                
                ,"form_language":"[form_language value n]"                
                ,"form_page_total":"[form_page_total value n]"                
                ,"form_lastpage_title":"[form_lastpage_title value n]"                
                ,"form_submit_primary_text":"[form_submit_primary_text value n]"                
                ,"form_submit_secondary_text":"[form_submit_secondary_text value n]"                
                ,"form_submit_primary_img":"[form_submit_primary_img value n]"                
                ,"form_submit_secondary_img":"[form_submit_secondary_img value n]"                
                ,"form_submit_use_image":"[form_submit_use_image value n]"                
                ,"form_review_primary_text":"[form_review_primary_text value n]"                
                ,"form_review_secondary_text":"[form_review_secondary_text value n]"                
                ,"form_review_primary_img":"[form_review_primary_img value n]"                
                ,"form_review_secondary_img":"[form_review_secondary_img value n]"                
                ,"form_review_use_image":"[form_review_use_image value n]"                
                ,"form_review_title":"[form_review_title value n]"                
                ,"form_review_description":"[form_review_description value n]"                
                ,"form_pagination_type":"[form_pagination_type value n]"                
                ,"form_schedule_enable":"[form_schedule_enable value n]"                
                ,"form_schedule_start_date":"[form_schedule_start_date value n]"                
                ,"form_schedule_end_date":"[form_schedule_end_date value n]"                
                ,"form_schedule_start_hour":"[form_schedule_start_hour value n]"                
                ,"form_schedule_end_hour":"[form_schedule_end_hour value n]"                
                ,"esl_enable":"[esl_enable value n]"                
                ,"esr_enable":"[esr_enable value n]"                
                ,"payment_enable_merchant":"[payment_enable_merchant value n]"                
                ,"payment_merchant_type":"[payment_merchant_type value n]"                
                ,"payment_paypal_email":"[payment_paypal_email value n]"                
                ,"payment_paypal_language":"[payment_paypal_language value n]"                
                ,"payment_currency":"[payment_currency value n]"                
                ,"payment_show_total":"[payment_show_total value n]"                
                ,"payment_total_location":"[payment_total_location value n]"                
                ,"payment_enable_recurring":"[payment_enable_recurring value n]"                
                ,"payment_recurring_cycle":"[payment_recurring_cycle value n]"                
                ,"payment_recurring_unit":"[payment_recurring_unit value n]"                
                ,"payment_price_type":"[payment_price_type value n]"                
                ,"payment_price_amount":"[payment_price_amount value n]"                
                ,"payment_price_name":"[payment_price_name value n]"                
                ,"logic_field_enable":"[logic_field_enable value n]"                
                ,"logic_page_enable":"[logic_page_enable value n]"                
                ,"payment_enable_trial":"[payment_enable_trial value n]"                
                ,"payment_trial_period":"[payment_trial_period value n]"                
                ,"payment_trial_unit":"[payment_trial_unit value n]"                
                ,"payment_trial_amount":"[payment_trial_amount value n]"                
                ,"payment_stripe_live_secret_key":"[payment_stripe_live_secret_key value n]"                
                ,"payment_stripe_live_public_key":"[payment_stripe_live_public_key value n]"                
                ,"payment_stripe_test_secret_key":"[payment_stripe_test_secret_key value n]"                
                ,"payment_stripe_test_public_key":"[payment_stripe_test_public_key value n]"                
                ,"payment_stripe_enable_test_mode":"[payment_stripe_enable_test_mode value n]"                
                ,"payment_paypal_enable_test_mode":"[payment_paypal_enable_test_mode value n]"                
                ,"payment_enable_invoice":"[payment_enable_invoice value n]"                
                ,"payment_invoice_email":"[payment_invoice_email value n]"                
                ,"payment_delay_notifications":"[payment_delay_notifications value n]"                
                ,"payment_ask_billing":"[payment_ask_billing value n]"                
                ,"payment_ask_shipping":"[payment_ask_shipping value n]"                
                ,"form_disabled_message":"[form_disabled_message value n]"                
                ,"payment_enable_tax":"[payment_enable_tax value n]"                
                ,"payment_tax_rate":"[payment_tax_rate value n]"                
                ,"logic_email_enable":"[logic_email_enable value n]"                
                ,"payment_enable_discount":"[payment_enable_discount value n]"                
                ,"payment_discount_type":"[payment_discount_type value n]"                
                ,"payment_discount_amount":"[payment_discount_amount value n]"                
                ,"payment_discount_code":"[payment_discount_code value n]"                
                ,"payment_discount_element_id":"[payment_discount_element_id value n]"                
                ,"payment_discount_max_usage":"[payment_discount_max_usage value n]"                
                ,"payment_discount_expiry_date":"[payment_discount_expiry_date value n]"                
                ,"webhook_enable":"[webhook_enable value n]"                
                ,"webhook_url":"[webhook_url value n]"                
                ,"webhook_method":"[webhook_method value n]"                
                ,"payment_paypal_rest_live_clientid":"[payment_paypal_rest_live_clientid value n]"                
                ,"payment_paypal_rest_live_secret_key":"[payment_paypal_rest_live_secret_key value n]"                
                ,"payment_paypal_rest_test_clientid":"[payment_paypal_rest_test_clientid value n]"                
                ,"payment_paypal_rest_test_secret_key":"[payment_paypal_rest_test_secret_key value n]"                
                ,"payment_paypal_rest_enable_test_mode":"[payment_paypal_rest_enable_test_mode value n]"                
                ,"payment_authorizenet_live_apiloginid":"[payment_authorizenet_live_apiloginid value n]"                
                ,"payment_authorizenet_live_transkey":"[payment_authorizenet_live_transkey value n]"                
                ,"payment_authorizenet_test_apiloginid":"[payment_authorizenet_test_apiloginid value n]"                
                ,"payment_authorizenet_test_transkey":"[payment_authorizenet_test_transkey value n]"                
                ,"payment_authorizenet_enable_test_mode":"[payment_authorizenet_enable_test_mode value n]"                
                ,"payment_authorizenet_save_cc_data":"[payment_authorizenet_save_cc_data value n]"                
                ,"payment_braintree_live_merchant_id":"[payment_braintree_live_merchant_id value n]"                
                ,"payment_braintree_live_public_key":"[payment_braintree_live_public_key value n]"                
                ,"payment_braintree_live_private_key":"[payment_braintree_live_private_key value n]"                
                ,"payment_braintree_live_encryption_key":"[payment_braintree_live_encryption_key value n]"                
                ,"payment_braintree_test_merchant_id":"[payment_braintree_test_merchant_id value n]"                
                ,"payment_braintree_test_public_key":"[payment_braintree_test_public_key value n]"                
                ,"payment_braintree_test_private_key":"[payment_braintree_test_private_key value n]"                
                ,"payment_braintree_test_encryption_key":"[payment_braintree_test_encryption_key value n]"                
                ,"payment_braintree_enable_test_mode":"[payment_braintree_enable_test_mode value n]"                
    
                },
    ],
    "total":123
}

ap_form_data

ap_form_data ...

Requesting Data

The ProFundCom API supports requests for ap_form_data data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of ap_form_data entities by ap_forms:form_id.
GET http://[root url]/ap_form_data/234

Response Payload
{
    "data":[   
                {
// values for object 1 - the contents of this object can vary    
                },
......
                {
// values for object n - the contents of this object can vary    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • DateCreatedAfter
  • DateUpdatedAfter
  • IDGreaterThan
  • id
For example
GET http://[root url]/ap_form_data?DateCreatedAfter=A%20filter%20value

attachment

...

Requesting Data

The ProFundCom API supports requests for attachment data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of entities .
GET http://[root url]/attachment
Response Payload
{
    "data":[   
                {
                "id_files":"[id_files value 1]"                
                ,"user_id":"[user_id value 1]"                
                ,"fund_id":"[fund_id value 1]"                
                ,"doc_type":"[doc_type value 1]"                
                ,"doc_active":"[doc_active value 1]"                
                ,"doc_retired":"[doc_retired value 1]"                
                ,"doc_class":"[doc_class value 1]"                
                ,"doc_group":"[doc_group value 1]"                
                ,"doc_month":"[doc_month value 1]"                
                ,"doc_year":"[doc_year value 1]"                
                ,"doc_metadata":"[doc_metadata value 1]"                
                ,"description":"[description value 1]"                
                ,"filename":"[filename value 1]"                
                ,"filesize":"[filesize value 1]"                
                ,"filetype":"[filetype value 1]"                
                ,"drm_expire_date":"[drm_expire_date value 1]"                
                ,"drm_expire_locations":"[drm_expire_locations value 1]"                
                ,"drm_expire_number_access":"[drm_expire_number_access value 1]"                
    
                },
......
                {
                "id_files":"[id_files value n]"                
                ,"user_id":"[user_id value n]"                
                ,"fund_id":"[fund_id value n]"                
                ,"doc_type":"[doc_type value n]"                
                ,"doc_active":"[doc_active value n]"                
                ,"doc_retired":"[doc_retired value n]"                
                ,"doc_class":"[doc_class value n]"                
                ,"doc_group":"[doc_group value n]"                
                ,"doc_month":"[doc_month value n]"                
                ,"doc_year":"[doc_year value n]"                
                ,"doc_metadata":"[doc_metadata value n]"                
                ,"description":"[description value n]"                
                ,"filename":"[filename value n]"                
                ,"filesize":"[filesize value n]"                
                ,"filetype":"[filetype value n]"                
                ,"drm_expire_date":"[drm_expire_date value n]"                
                ,"drm_expire_locations":"[drm_expire_locations value n]"                
                ,"drm_expire_number_access":"[drm_expire_number_access value n]"                
    
                },
    ],
    "total":123
}

Requesting an Individual Entity by ID

The request below returns the collection of attachment entity identified by id_files.
GET http://[root url]/attachment/234
Response Payload
{
    "data":[   
                {
                "id_files":"[id_files value]"                
                ,"user_id":"[user_id value]"                
                ,"fund_id":"[fund_id value]"                
                ,"doc_type":"[doc_type value]"                
                ,"doc_active":"[doc_active value]"                
                ,"doc_retired":"[doc_retired value]"                
                ,"doc_class":"[doc_class value]"                
                ,"doc_group":"[doc_group value]"                
                ,"doc_month":"[doc_month value]"                
                ,"doc_year":"[doc_year value]"                
                ,"doc_metadata":"[doc_metadata value]"                
                ,"description":"[description value]"                
                ,"filename":"[filename value]"                
                ,"filesize":"[filesize value]"                
                ,"filetype":"[filetype value]"                
                ,"drm_expire_date":"[drm_expire_date value]"                
                ,"drm_expire_locations":"[drm_expire_locations value]"                
                ,"drm_expire_number_access":"[drm_expire_number_access value]"                
    
                }
    ],
    "total":1
}

audit_log_email

Audit Log Email ...

Requesting Data

The ProFundCom API supports requests for audit_log_email data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of Audit Log Email entities .
GET http://[root url]/audit_log_email
Response Payload
{
    "data":[   
                {
                "_id":"[_id value 1]"                
                ,"subject":"[subject value 1]"                
                ,"email_batch_id":"[email_batch_id value 1]"                
                ,"Email":"[Email value 1]"  // The email address the email was sent to                
                ,"user_id":"[user_id value 1]"  // The internal ID of the ProFundCom user who sent the email                
                ,"owner_name":"[owner_name value 1]"                
                ,"campaign_id":"[campaign_id value 1]"                
                ,"campaign_name":"[campaign_name value 1]"                
                ,"email_send":"[email_send value 1]"  // The date and time the email was sent to the email queue                
    
                },
......
                {
                "_id":"[_id value n]"                
                ,"subject":"[subject value n]"                
                ,"email_batch_id":"[email_batch_id value n]"                
                ,"Email":"[Email value n]"  // The email address the email was sent to                
                ,"user_id":"[user_id value n]"  // The internal ID of the ProFundCom user who sent the email                
                ,"owner_name":"[owner_name value n]"                
                ,"campaign_id":"[campaign_id value n]"                
                ,"campaign_name":"[campaign_name value n]"                
                ,"email_send":"[email_send value n]"  // The date and time the email was sent to the email queue                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • ID
  • email_id
  • IDGreaterThan
  • DateAfter
  • Email
For example
GET http://[root url]/audit_log_email?ID=A%20filter%20value

campaign

campaign ...

Requesting Data

The ProFundCom API supports requests for campaign data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of campaign entities .
GET http://[root url]/campaign
Response Payload
{
    "data":[   
                {
                "campaign_id":"[campaign_id value 1]"                
                ,"campaign_name":"[campaign_name value 1]"                
                ,"campaign_user":"[campaign_user value 1]"                
                ,"campaign_date":"[campaign_date value 1]"                
    
                },
......
                {
                "campaign_id":"[campaign_id value n]"                
                ,"campaign_name":"[campaign_name value n]"                
                ,"campaign_user":"[campaign_user value n]"                
                ,"campaign_date":"[campaign_date value n]"                
    
                },
    ],
    "total":123
}

Requesting an Individual Entity by ID

The request below returns the collection of campaign entity identified by campaign_id.
GET http://[root url]/campaign/234
Response Payload
{
    "data":[   
                {
                "campaign_id":"[campaign_id value]"                
                ,"campaign_name":"[campaign_name value]"                
                ,"campaign_user":"[campaign_user value]"                
                ,"campaign_date":"[campaign_date value]"                
    
                }
    ],
    "total":1
}

Data Modification

The ProFundCom API supports Create, Update and Delete operations for campaign entities.

Create an Entity

To create an entity in a collection, the client sends a POST request to the campaign collection's URL with the Content-Type "application/json". The POST body MUST contain a single valid entity representation. The request below creates a campaign.
POST http://[root url]/campaign
Content-Type: application/json;
BODY
{
                "campaign_name":"[campaign_name value (required)]"                
                ,"campaign_date":"[campaign_date value]"                
    
}
Response Payload
{
    "responseStatus":"Ok",
    "campaign_id":"[the new enitity's campaign_id]"
}

Remove an Entity

By specification, to remove an entity in a collection, the client sends a DELETE request to the campaign entity's url.
DELETE http://[root url]/campaign/234
HOWEVER, for compatability this action is performed by using a POST with an Action parameter "delete" in the query string
POST http://[root url]/campaign/234?Action=delete
Response Payload
{
    "responseStatus":"Ok",
}

Update an Entity

By specification, to update an entity in a collection, the client sends a PUT request to the campaign entity's url with the Content-Type "application/json".
PUT http://[root url]/campaign/234
Content-Type: application/json;
BODY
{
                "campaign_name":"[campaign_name value]"                
                ,"campaign_date":"[campaign_date value]"                
    
}
HOWEVER, for compatability this action is performed by using a POST with an Action parameter "update" in the query string
POST http://[root url]/campaign/234?Action=update
Content-Type: application/json;
BODY
{
                "campaign_name":"[campaign_name value (required)]"                
                "campaign_date":"[campaign_date value]"                
    
}
Response Payload
{
    "responseStatus":"Ok",
}

configFields

configFields ...

Requesting Data

The ProFundCom API supports requests for configFields data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of configFields entities .
GET http://[root url]/configFields
Response Payload
{
    "data":[   
                {
                "id":"[id value 1]"                
                ,"company_name":"[company_name value 1]"                
                ,"company_name_abbr":"[company_name_abbr value 1]"                
                ,"company_image":"[company_image value 1]"                
                ,"application_title":"[application_title value 1]"                
                ,"application_url":"[application_url value 1]"                
                ,"application_url_image":"[application_url_image value 1]"                
                ,"application_dir":"[application_dir value 1]"                
                ,"application_db":"[application_db value 1]"                
                ,"application_refresh":"[application_refresh value 1]"                
                ,"application_domain":"[application_domain value 1]"                
                ,"application_helpfile":"[application_helpfile value 1]"                
                ,"application_version":"[application_version value 1]"                
                ,"from_email":"[from_email value 1]"                
                ,"from_email_name":"[from_email_name value 1]"                
                ,"from_email_name_scheduled_report":"[from_email_name_scheduled_report value 1]"                
                ,"from_email_scheduled_report":"[from_email_scheduled_report value 1]"                
                ,"document_url":"[document_url value 1]"                
                ,"document_url_campaign":"[document_url_campaign value 1]"                
                ,"document_url_custom":"[document_url_custom value 1]"                
                ,"email_default_font":"[email_default_font value 1]"                
                ,"email_default_font_size":"[email_default_font_size value 1]"                
                ,"email_signature":"[email_signature value 1]"                
                ,"email_signature_active":"[email_signature_active value 1]"                
                ,"email_queue_manual":"[email_queue_manual value 1]"                
                ,"default_template_id":"[default_template_id value 1]"                
                ,"import_mode":"[import_mode value 1]"                
                ,"export_mode":"[export_mode value 1]"                
                ,"outlook_mode":"[outlook_mode value 1]"                
                ,"test_email":"[test_email value 1]"                
                ,"bcc_email":"[bcc_email value 1]"                
                ,"alert_email":"[alert_email value 1]"                
                ,"unsubscribe_email":"[unsubscribe_email value 1]"                
                ,"bounce_email":"[bounce_email value 1]"                
                ,"bounce_email_password":"[bounce_email_password value 1]"                
                ,"bounce_email_server":"[bounce_email_server value 1]"                
                ,"bounce_ignore":"[bounce_ignore value 1]"                
                ,"ftp_address":"[ftp_address value 1]"                
                ,"ftp_user":"[ftp_user value 1]"                
                ,"ftp_pwd":"[ftp_pwd value 1]"                
                ,"ftp_local_path":"[ftp_local_path value 1]"                
                ,"ftp_remote_path":"[ftp_remote_path value 1]"                
                ,"ftp_file":"[ftp_file value 1]"                
                ,"pfc_local_docs":"[pfc_local_docs value 1]"                
                ,"pfc_local_links":"[pfc_local_links value 1]"                
                ,"pfc_industry_docs":"[pfc_industry_docs value 1]"                
                ,"pfc_industry_links":"[pfc_industry_links value 1]"                
                ,"smtp_mail_server_alert":"[smtp_mail_server_alert value 1]"                
                ,"smtp_mail_server":"[smtp_mail_server value 1]"                
                ,"pdf_download_path":"[pdf_download_path value 1]"                
                ,"group_tag":"[group_tag value 1]"                
                ,"group_html":"[group_html value 1]"                
                ,"group_wizard_html":"[group_wizard_html value 1]"                
                ,"group_html_temp":"[group_html_temp value 1]"                
                ,"group_crm_update":"[group_crm_update value 1]"                
                ,"group_crm_update_flag":"[group_crm_update_flag value 1]"                
                ,"campaign_auto":"[campaign_auto value 1]"                
                ,"mapped_fields_static":"[mapped_fields_static value 1]"                
                ,"non_mapped_fields_static":"[non_mapped_fields_static value 1]"                
                ,"fund_name_overwrite":"[fund_name_overwrite value 1]"                
                ,"DataGenerationTruncateDate":"[DataGenerationTruncateDate value 1]"                
                ,"attachment_mode":"[attachment_mode value 1]"                
                ,"attachment_mode_extract_html":"[attachment_mode_extract_html value 1]"                
                ,"attachment_mode_dynamic":"[attachment_mode_dynamic value 1]"                
                ,"attachment_mode_autolink":"[attachment_mode_autolink value 1]"                
                ,"performance_queue":"[performance_queue value 1]"                
                ,"automate_running":"[automate_running value 1]"                
                ,"performance_log":"[performance_log value 1]"                
                ,"salutation_mode":"[salutation_mode value 1]"                
                ,"embed_images":"[embed_images value 1]"                
                ,"blast_mode":"[blast_mode value 1]"                
                ,"old_editor":"[old_editor value 1]"                
                ,"editor_target":"[editor_target value 1]"                
                ,"hide_fund_label":"[hide_fund_label value 1]"                
                ,"demon_running":"[demon_running value 1]"                
                ,"demon_last_run":"[demon_last_run value 1]"                
                ,"demon_queue_size":"[demon_queue_size value 1]"                
                ,"sleep_scanned":"[sleep_scanned value 1]"                
                ,"sleep_read":"[sleep_read value 1]"                
                ,"email_queue_write_active":"[email_queue_write_active value 1]"                
                ,"email_queue_json_demon":"[email_queue_json_demon value 1]"                
                ,"high_performance_queue_size":"[high_performance_queue_size value 1]"                
                ,"high_performance_queue_sleep":"[high_performance_queue_sleep value 1]"                
                ,"track_attachments":"[track_attachments value 1]"                
                ,"track_weblinks":"[track_weblinks value 1]"                
                ,"track_delivery":"[track_delivery value 1]"                
                ,"track_open":"[track_open value 1]"                
                ,"track_printed":"[track_printed value 1]"                
                ,"track_forward":"[track_forward value 1]"                
                ,"track_scanned":"[track_scanned value 1]"                
                ,"log_attachments":"[log_attachments value 1]"                
                ,"template_auto_campaign":"[template_auto_campaign value 1]"                
                ,"template_autolink_hide":"[template_autolink_hide value 1]"                
                ,"template_auto_check":"[template_auto_check value 1]"                
                ,"template_cc":"[template_cc value 1]"                
                ,"console_display_latest":"[console_display_latest value 1]"                
                ,"template_link_limit":"[template_link_limit value 1]"                
                ,"template_doc_limit":"[template_doc_limit value 1]"                
                ,"filter_indi":"[filter_indi value 1]"                
                ,"filter_group":"[filter_group value 1]"                
                ,"filter_campaign_interval":"[filter_campaign_interval value 1]"                
                ,"filter_campaign_summary":"[filter_campaign_summary value 1]"                
                ,"filter_campaign":"[filter_campaign value 1]"                
                ,"sendgrid_host":"[sendgrid_host value 1]"                
                ,"sendgrid_user":"[sendgrid_user value 1]"                
                ,"sendgrid_pass":"[sendgrid_pass value 1]"                
                ,"ews_mode":"[ews_mode value 1]"                
                ,"ews_user":"[ews_user value 1]"                
                ,"ews_password":"[ews_password value 1]"                
                ,"ews_server":"[ews_server value 1]"                
                ,"ews_email_address":"[ews_email_address value 1]"                
                ,"ews_email_name":"[ews_email_name value 1]"                
                ,"ews_delay":"[ews_delay value 1]"                
                ,"aggregated_campaign_report":"[aggregated_campaign_report value 1]"                
                ,"live_chat_active":"[live_chat_active value 1]"                
                ,"mailing_list_seperator":"[mailing_list_seperator value 1]"                
                ,"multithread_mode":"[multithread_mode value 1]"                
                ,"host_api_alive":"[host_api_alive value 1]"                
                ,"Editor_URLType":"[Editor_URLType value 1]"                
                ,"sfdc_username":"[sfdc_username value 1]"                
                ,"sfdc_password":"[sfdc_password value 1]"                
                ,"sfdc_token":"[sfdc_token value 1]"                
                ,"whatisnew":"[whatisnew value 1]"                
                ,"display_thumbnails":"[display_thumbnails value 1]"                
                ,"upload_wizard_update":"[upload_wizard_update value 1]"                
                ,"unsubscribe_block_1":"[unsubscribe_block_1 value 1]"                
                ,"unsubscribe_block_2":"[unsubscribe_block_2 value 1]"                
                ,"unsubscribe_block_3":"[unsubscribe_block_3 value 1]"                
                ,"unsubscribe_block_4":"[unsubscribe_block_4 value 1]"                
                ,"unsubscribe_all_active":"[unsubscribe_all_active value 1]"                
                ,"unsubscribe_by_fund":"[unsubscribe_by_fund value 1]"                
                ,"unsubscribe_ignore":"[unsubscribe_ignore value 1]"                
                ,"check_for_image_errors":"[check_for_image_errors value 1]"                
                ,"display_campaign_stats":"[display_campaign_stats value 1]"                
                ,"crm_contact_details":"[crm_contact_details value 1]"                
                ,"local_time_zone":"[local_time_zone value 1]"                
                ,"local_time_format":"[local_time_format value 1]"                
                ,"custom_report_colors":"[custom_report_colors value 1]"                
                ,"send_wizard_preview_mode":"[send_wizard_preview_mode value 1]"                
                ,"send_wizard_json_mail_merge":"[send_wizard_json_mail_merge value 1]"                
                ,"send_wizard_mailing_list_order":"[send_wizard_mailing_list_order value 1]"                
                ,"send_wizard_remove_duplicates":"[send_wizard_remove_duplicates value 1]"                
                ,"background_email_build":"[background_email_build value 1]"                
                ,"email_build_in_progress":"[email_build_in_progress value 1]"                
                ,"email_build_last_run":"[email_build_last_run value 1]"                
                ,"drm_active":"[drm_active value 1]"                
                ,"email_build_via_build_queue":"[email_build_via_build_queue value 1]"                
                ,"dotnet_smtp_host":"[dotnet_smtp_host value 1]"                
                ,"dotnet_smtp_user":"[dotnet_smtp_user value 1]"                
                ,"dotnet_smtp_pass":"[dotnet_smtp_pass value 1]"                
                ,"dotnet_smtp_mailfrom":"[dotnet_smtp_mailfrom value 1]"                
                ,"licence_concurrent":"[licence_concurrent value 1]"                
                ,"template_backup_interval":"[template_backup_interval value 1]"                
                ,"crm_sync_start":"[crm_sync_start value 1]"                
                ,"crm_sync_end":"[crm_sync_end value 1]"                
                ,"build_cms_user_rating":"[build_cms_user_rating value 1]"                
                ,"send_scheduled_reports_as_csv":"[send_scheduled_reports_as_csv value 1]"                
                ,"stop_words":"[stop_words value 1]"                
                ,"custom_menu":"[custom_menu value 1]"                
                ,"app_store_google_analytics":"[app_store_google_analytics value 1]"                
                ,"show_grid_in_new_tab":"[show_grid_in_new_tab value 1]"                
                ,"app_store_social_media_tracking":"[app_store_social_media_tracking value 1]"                
                ,"advance_wizard_start_page":"[advance_wizard_start_page value 1]"                
                ,"link_error_detect":"[link_error_detect value 1]"                
                ,"drm_message_1":"[drm_message_1 value 1]"                
                ,"drm_message_2":"[drm_message_2 value 1]"                
                ,"drm_message_3":"[drm_message_3 value 1]"                
                ,"drm_message_4":"[drm_message_4 value 1]"                
                ,"drm_message_5":"[drm_message_5 value 1]"                
                ,"Use_IP_Lookup_For_Existing_Unidentified_Browsers":"[Use_IP_Lookup_For_Existing_Unidentified_Browsers value 1]"                
                ,"Use_IP_Lookup_For_New_Unidentified_Browsers":"[Use_IP_Lookup_For_New_Unidentified_Browsers value 1]"                
                ,"Exclude_IP_Addresses_From_IP_Lookup":"[Exclude_IP_Addresses_From_IP_Lookup value 1]"                
                ,"IP_Associations_Cleared_At":"[IP_Associations_Cleared_At value 1]"                
                ,"webpage_tracking_code":"[webpage_tracking_code value 1]"                
                ,"Include_Unmatched_Web_In_Transactions":"[Include_Unmatched_Web_In_Transactions value 1]"                
                ,"Use_IP_Lookup_Records_Up_To_Minutes":"[Use_IP_Lookup_Records_Up_To_Minutes value 1]"                
                ,"Editor_Type":"[Editor_Type value 1]"                
                ,"distribution_groups_need_updating":"[distribution_groups_need_updating value 1]"                
                ,"distribution_group_status_hide":"[distribution_group_status_hide value 1]"                
                ,"automatically_update_html_matrix":"[automatically_update_html_matrix value 1]"                
                ,"send_wizard_reply_email_crm":"[send_wizard_reply_email_crm value 1]"                
                ,"send_wizard_reply_email_template":"[send_wizard_reply_email_template value 1]"                
                ,"send_wizard_from_email_crm":"[send_wizard_from_email_crm value 1]"                
                ,"send_wizard_from_email_template":"[send_wizard_from_email_template value 1]"                
                ,"discard_scheduled_sent_logs":"[discard_scheduled_sent_logs value 1]"                
    
                },
......
                {
                "id":"[id value n]"                
                ,"company_name":"[company_name value n]"                
                ,"company_name_abbr":"[company_name_abbr value n]"                
                ,"company_image":"[company_image value n]"                
                ,"application_title":"[application_title value n]"                
                ,"application_url":"[application_url value n]"                
                ,"application_url_image":"[application_url_image value n]"                
                ,"application_dir":"[application_dir value n]"                
                ,"application_db":"[application_db value n]"                
                ,"application_refresh":"[application_refresh value n]"                
                ,"application_domain":"[application_domain value n]"                
                ,"application_helpfile":"[application_helpfile value n]"                
                ,"application_version":"[application_version value n]"                
                ,"from_email":"[from_email value n]"                
                ,"from_email_name":"[from_email_name value n]"                
                ,"from_email_name_scheduled_report":"[from_email_name_scheduled_report value n]"                
                ,"from_email_scheduled_report":"[from_email_scheduled_report value n]"                
                ,"document_url":"[document_url value n]"                
                ,"document_url_campaign":"[document_url_campaign value n]"                
                ,"document_url_custom":"[document_url_custom value n]"                
                ,"email_default_font":"[email_default_font value n]"                
                ,"email_default_font_size":"[email_default_font_size value n]"                
                ,"email_signature":"[email_signature value n]"                
                ,"email_signature_active":"[email_signature_active value n]"                
                ,"email_queue_manual":"[email_queue_manual value n]"                
                ,"default_template_id":"[default_template_id value n]"                
                ,"import_mode":"[import_mode value n]"                
                ,"export_mode":"[export_mode value n]"                
                ,"outlook_mode":"[outlook_mode value n]"                
                ,"test_email":"[test_email value n]"                
                ,"bcc_email":"[bcc_email value n]"                
                ,"alert_email":"[alert_email value n]"                
                ,"unsubscribe_email":"[unsubscribe_email value n]"                
                ,"bounce_email":"[bounce_email value n]"                
                ,"bounce_email_password":"[bounce_email_password value n]"                
                ,"bounce_email_server":"[bounce_email_server value n]"                
                ,"bounce_ignore":"[bounce_ignore value n]"                
                ,"ftp_address":"[ftp_address value n]"                
                ,"ftp_user":"[ftp_user value n]"                
                ,"ftp_pwd":"[ftp_pwd value n]"                
                ,"ftp_local_path":"[ftp_local_path value n]"                
                ,"ftp_remote_path":"[ftp_remote_path value n]"                
                ,"ftp_file":"[ftp_file value n]"                
                ,"pfc_local_docs":"[pfc_local_docs value n]"                
                ,"pfc_local_links":"[pfc_local_links value n]"                
                ,"pfc_industry_docs":"[pfc_industry_docs value n]"                
                ,"pfc_industry_links":"[pfc_industry_links value n]"                
                ,"smtp_mail_server_alert":"[smtp_mail_server_alert value n]"                
                ,"smtp_mail_server":"[smtp_mail_server value n]"                
                ,"pdf_download_path":"[pdf_download_path value n]"                
                ,"group_tag":"[group_tag value n]"                
                ,"group_html":"[group_html value n]"                
                ,"group_wizard_html":"[group_wizard_html value n]"                
                ,"group_html_temp":"[group_html_temp value n]"                
                ,"group_crm_update":"[group_crm_update value n]"                
                ,"group_crm_update_flag":"[group_crm_update_flag value n]"                
                ,"campaign_auto":"[campaign_auto value n]"                
                ,"mapped_fields_static":"[mapped_fields_static value n]"                
                ,"non_mapped_fields_static":"[non_mapped_fields_static value n]"                
                ,"fund_name_overwrite":"[fund_name_overwrite value n]"                
                ,"DataGenerationTruncateDate":"[DataGenerationTruncateDate value n]"                
                ,"attachment_mode":"[attachment_mode value n]"                
                ,"attachment_mode_extract_html":"[attachment_mode_extract_html value n]"                
                ,"attachment_mode_dynamic":"[attachment_mode_dynamic value n]"                
                ,"attachment_mode_autolink":"[attachment_mode_autolink value n]"                
                ,"performance_queue":"[performance_queue value n]"                
                ,"automate_running":"[automate_running value n]"                
                ,"performance_log":"[performance_log value n]"                
                ,"salutation_mode":"[salutation_mode value n]"                
                ,"embed_images":"[embed_images value n]"                
                ,"blast_mode":"[blast_mode value n]"                
                ,"old_editor":"[old_editor value n]"                
                ,"editor_target":"[editor_target value n]"                
                ,"hide_fund_label":"[hide_fund_label value n]"                
                ,"demon_running":"[demon_running value n]"                
                ,"demon_last_run":"[demon_last_run value n]"                
                ,"demon_queue_size":"[demon_queue_size value n]"                
                ,"sleep_scanned":"[sleep_scanned value n]"                
                ,"sleep_read":"[sleep_read value n]"                
                ,"email_queue_write_active":"[email_queue_write_active value n]"                
                ,"email_queue_json_demon":"[email_queue_json_demon value n]"                
                ,"high_performance_queue_size":"[high_performance_queue_size value n]"                
                ,"high_performance_queue_sleep":"[high_performance_queue_sleep value n]"                
                ,"track_attachments":"[track_attachments value n]"                
                ,"track_weblinks":"[track_weblinks value n]"                
                ,"track_delivery":"[track_delivery value n]"                
                ,"track_open":"[track_open value n]"                
                ,"track_printed":"[track_printed value n]"                
                ,"track_forward":"[track_forward value n]"                
                ,"track_scanned":"[track_scanned value n]"                
                ,"log_attachments":"[log_attachments value n]"                
                ,"template_auto_campaign":"[template_auto_campaign value n]"                
                ,"template_autolink_hide":"[template_autolink_hide value n]"                
                ,"template_auto_check":"[template_auto_check value n]"                
                ,"template_cc":"[template_cc value n]"                
                ,"console_display_latest":"[console_display_latest value n]"                
                ,"template_link_limit":"[template_link_limit value n]"                
                ,"template_doc_limit":"[template_doc_limit value n]"                
                ,"filter_indi":"[filter_indi value n]"                
                ,"filter_group":"[filter_group value n]"                
                ,"filter_campaign_interval":"[filter_campaign_interval value n]"                
                ,"filter_campaign_summary":"[filter_campaign_summary value n]"                
                ,"filter_campaign":"[filter_campaign value n]"                
                ,"sendgrid_host":"[sendgrid_host value n]"                
                ,"sendgrid_user":"[sendgrid_user value n]"                
                ,"sendgrid_pass":"[sendgrid_pass value n]"                
                ,"ews_mode":"[ews_mode value n]"                
                ,"ews_user":"[ews_user value n]"                
                ,"ews_password":"[ews_password value n]"                
                ,"ews_server":"[ews_server value n]"                
                ,"ews_email_address":"[ews_email_address value n]"                
                ,"ews_email_name":"[ews_email_name value n]"                
                ,"ews_delay":"[ews_delay value n]"                
                ,"aggregated_campaign_report":"[aggregated_campaign_report value n]"                
                ,"live_chat_active":"[live_chat_active value n]"                
                ,"mailing_list_seperator":"[mailing_list_seperator value n]"                
                ,"multithread_mode":"[multithread_mode value n]"                
                ,"host_api_alive":"[host_api_alive value n]"                
                ,"Editor_URLType":"[Editor_URLType value n]"                
                ,"sfdc_username":"[sfdc_username value n]"                
                ,"sfdc_password":"[sfdc_password value n]"                
                ,"sfdc_token":"[sfdc_token value n]"                
                ,"whatisnew":"[whatisnew value n]"                
                ,"display_thumbnails":"[display_thumbnails value n]"                
                ,"upload_wizard_update":"[upload_wizard_update value n]"                
                ,"unsubscribe_block_1":"[unsubscribe_block_1 value n]"                
                ,"unsubscribe_block_2":"[unsubscribe_block_2 value n]"                
                ,"unsubscribe_block_3":"[unsubscribe_block_3 value n]"                
                ,"unsubscribe_block_4":"[unsubscribe_block_4 value n]"                
                ,"unsubscribe_all_active":"[unsubscribe_all_active value n]"                
                ,"unsubscribe_by_fund":"[unsubscribe_by_fund value n]"                
                ,"unsubscribe_ignore":"[unsubscribe_ignore value n]"                
                ,"check_for_image_errors":"[check_for_image_errors value n]"                
                ,"display_campaign_stats":"[display_campaign_stats value n]"                
                ,"crm_contact_details":"[crm_contact_details value n]"                
                ,"local_time_zone":"[local_time_zone value n]"                
                ,"local_time_format":"[local_time_format value n]"                
                ,"custom_report_colors":"[custom_report_colors value n]"                
                ,"send_wizard_preview_mode":"[send_wizard_preview_mode value n]"                
                ,"send_wizard_json_mail_merge":"[send_wizard_json_mail_merge value n]"                
                ,"send_wizard_mailing_list_order":"[send_wizard_mailing_list_order value n]"                
                ,"send_wizard_remove_duplicates":"[send_wizard_remove_duplicates value n]"                
                ,"background_email_build":"[background_email_build value n]"                
                ,"email_build_in_progress":"[email_build_in_progress value n]"                
                ,"email_build_last_run":"[email_build_last_run value n]"                
                ,"drm_active":"[drm_active value n]"                
                ,"email_build_via_build_queue":"[email_build_via_build_queue value n]"                
                ,"dotnet_smtp_host":"[dotnet_smtp_host value n]"                
                ,"dotnet_smtp_user":"[dotnet_smtp_user value n]"                
                ,"dotnet_smtp_pass":"[dotnet_smtp_pass value n]"                
                ,"dotnet_smtp_mailfrom":"[dotnet_smtp_mailfrom value n]"                
                ,"licence_concurrent":"[licence_concurrent value n]"                
                ,"template_backup_interval":"[template_backup_interval value n]"                
                ,"crm_sync_start":"[crm_sync_start value n]"                
                ,"crm_sync_end":"[crm_sync_end value n]"                
                ,"build_cms_user_rating":"[build_cms_user_rating value n]"                
                ,"send_scheduled_reports_as_csv":"[send_scheduled_reports_as_csv value n]"                
                ,"stop_words":"[stop_words value n]"                
                ,"custom_menu":"[custom_menu value n]"                
                ,"app_store_google_analytics":"[app_store_google_analytics value n]"                
                ,"show_grid_in_new_tab":"[show_grid_in_new_tab value n]"                
                ,"app_store_social_media_tracking":"[app_store_social_media_tracking value n]"                
                ,"advance_wizard_start_page":"[advance_wizard_start_page value n]"                
                ,"link_error_detect":"[link_error_detect value n]"                
                ,"drm_message_1":"[drm_message_1 value n]"                
                ,"drm_message_2":"[drm_message_2 value n]"                
                ,"drm_message_3":"[drm_message_3 value n]"                
                ,"drm_message_4":"[drm_message_4 value n]"                
                ,"drm_message_5":"[drm_message_5 value n]"                
                ,"Use_IP_Lookup_For_Existing_Unidentified_Browsers":"[Use_IP_Lookup_For_Existing_Unidentified_Browsers value n]"                
                ,"Use_IP_Lookup_For_New_Unidentified_Browsers":"[Use_IP_Lookup_For_New_Unidentified_Browsers value n]"                
                ,"Exclude_IP_Addresses_From_IP_Lookup":"[Exclude_IP_Addresses_From_IP_Lookup value n]"                
                ,"IP_Associations_Cleared_At":"[IP_Associations_Cleared_At value n]"                
                ,"webpage_tracking_code":"[webpage_tracking_code value n]"                
                ,"Include_Unmatched_Web_In_Transactions":"[Include_Unmatched_Web_In_Transactions value n]"                
                ,"Use_IP_Lookup_Records_Up_To_Minutes":"[Use_IP_Lookup_Records_Up_To_Minutes value n]"                
                ,"Editor_Type":"[Editor_Type value n]"                
                ,"distribution_groups_need_updating":"[distribution_groups_need_updating value n]"                
                ,"distribution_group_status_hide":"[distribution_group_status_hide value n]"                
                ,"automatically_update_html_matrix":"[automatically_update_html_matrix value n]"                
                ,"send_wizard_reply_email_crm":"[send_wizard_reply_email_crm value n]"                
                ,"send_wizard_reply_email_template":"[send_wizard_reply_email_template value n]"                
                ,"send_wizard_from_email_crm":"[send_wizard_from_email_crm value n]"                
                ,"send_wizard_from_email_template":"[send_wizard_from_email_template value n]"                
                ,"discard_scheduled_sent_logs":"[discard_scheduled_sent_logs value n]"                
    
                },
    ],
    "total":123
}

Data Modification

The ProFundCom API supports Create, Update and Delete operations for configFields entities.

Create an Entity

To create an entity in a collection, the client sends a POST request to the configFields collection's URL with the Content-Type "application/json". The POST body MUST contain a single valid entity representation. The request below creates a configFields.
POST http://[root url]/configFields
Content-Type: application/json;
BODY
{
    
}
Response Payload
{
    "responseStatus":"Ok",
    "":"[the new enitity's ]"
}

Remove an Entity

By specification, to remove an entity in a collection, the client sends a DELETE request to the configFields entity's url.
DELETE http://[root url]/configFields/234
HOWEVER, for compatability this action is performed by using a POST with an Action parameter "delete" in the query string
POST http://[root url]/configFields/234?Action=delete
Response Payload
{
    "responseStatus":"Ok",
}

Update an Entity

By specification, to update an entity in a collection, the client sends a PUT request to the configFields entity's url with the Content-Type "application/json".
PUT http://[root url]/configFields/234
Content-Type: application/json;
BODY
{
    
}
HOWEVER, for compatability this action is performed by using a POST with an Action parameter "update" in the query string
POST http://[root url]/configFields/234?Action=update
Content-Type: application/json;
BODY
{
    
}
Response Payload
{
    "responseStatus":"Ok",
}

contact

contact ...

Requesting Data

The ProFundCom API supports requests for contact data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of contact entities .
GET http://[root url]/contact
Response Payload
{
    "data":[   
                {
                "_id":"[_id value 1]"                
                ,"title":"[title value 1]"                
                ,"contact":"[contact value 1]"                
                ,"firstName":"[firstName value 1]"                
                ,"surname":"[surname value 1]"                
                ,"email":"[email value 1]"                
                ,"company":"[company value 1]"                
                ,"status":"[status value 1]"                
                ,"phone":"[phone value 1]"                
                ,"city":"[city value 1]"                
                ,"country":"[country value 1]"                
                ,"reply_email":"[reply_email value 1]"                
                ,"account_manager":"[account_manager value 1]"                
                ,"reply_name":"[reply_name value 1]"                
                ,"Record_Manager":"[Record_Manager value 1]"                
                ,"Address_1":"[Address_1 value 1]"                
                ,"Address_2":"[Address_2 value 1]"                
                ,"Address_3":"[Address_3 value 1]"                
                ,"County":"[County value 1]"                
                ,"Postcode":"[Postcode value 1]"                
                ,"Fax":"[Fax value 1]"                
                ,"Mobile_Phone":"[Mobile_Phone value 1]"                
                ,"interest":"[interest value 1]"                
                ,"Last_Name":"[Last_Name value 1]"                
                ,"Relationship_Status":"[Relationship_Status value 1]"                
                ,"Company_subtype":"[Company_subtype value 1]"                
                ,"MGMF_LTD":"[MGMF_LTD value 1]"                
                ,"MGMF_LLC":"[MGMF_LLC value 1]"                
    
                },
......
                {
                "_id":"[_id value n]"                
                ,"title":"[title value n]"                
                ,"contact":"[contact value n]"                
                ,"firstName":"[firstName value n]"                
                ,"surname":"[surname value n]"                
                ,"email":"[email value n]"                
                ,"company":"[company value n]"                
                ,"status":"[status value n]"                
                ,"phone":"[phone value n]"                
                ,"city":"[city value n]"                
                ,"country":"[country value n]"                
                ,"reply_email":"[reply_email value n]"                
                ,"account_manager":"[account_manager value n]"                
                ,"reply_name":"[reply_name value n]"                
                ,"Record_Manager":"[Record_Manager value n]"                
                ,"Address_1":"[Address_1 value n]"                
                ,"Address_2":"[Address_2 value n]"                
                ,"Address_3":"[Address_3 value n]"                
                ,"County":"[County value n]"                
                ,"Postcode":"[Postcode value n]"                
                ,"Fax":"[Fax value n]"                
                ,"Mobile_Phone":"[Mobile_Phone value n]"                
                ,"interest":"[interest value n]"                
                ,"Last_Name":"[Last_Name value n]"                
                ,"Relationship_Status":"[Relationship_Status value n]"                
                ,"Company_subtype":"[Company_subtype value n]"                
                ,"MGMF_LTD":"[MGMF_LTD value n]"                
                ,"MGMF_LLC":"[MGMF_LLC value n]"                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • email
For example
GET http://[root url]/contact?email=A%20filter%20value

Requesting an Individual Entity by ID

The request below returns the collection of contact entity identified by _id.
GET http://[root url]/contact/234
Response Payload
{
    "data":[   
                {
                "_id":"[_id value]"                
                ,"title":"[title value]"                
                ,"contact":"[contact value]"                
                ,"firstName":"[firstName value]"                
                ,"surname":"[surname value]"                
                ,"email":"[email value]"                
                ,"company":"[company value]"                
                ,"status":"[status value]"                
                ,"phone":"[phone value]"                
                ,"city":"[city value]"                
                ,"country":"[country value]"                
                ,"reply_email":"[reply_email value]"                
                ,"account_manager":"[account_manager value]"                
                ,"reply_name":"[reply_name value]"                
                ,"Record_Manager":"[Record_Manager value]"                
                ,"Address_1":"[Address_1 value]"                
                ,"Address_2":"[Address_2 value]"                
                ,"Address_3":"[Address_3 value]"                
                ,"County":"[County value]"                
                ,"Postcode":"[Postcode value]"                
                ,"Fax":"[Fax value]"                
                ,"Mobile_Phone":"[Mobile_Phone value]"                
                ,"interest":"[interest value]"                
                ,"Last_Name":"[Last_Name value]"                
                ,"Relationship_Status":"[Relationship_Status value]"                
                ,"Company_subtype":"[Company_subtype value]"                
                ,"MGMF_LTD":"[MGMF_LTD value]"                
                ,"MGMF_LLC":"[MGMF_LLC value]"                
    
                }
    ],
    "total":1
}

Data Modification

The ProFundCom API supports Create, Update and Delete operations for contact entities.

Create an Entity

To create an entity in a collection, the client sends a POST request to the contact collection's URL with the Content-Type "application/json". The POST body MUST contain a single valid entity representation. The request below creates a contact.
POST http://[root url]/contact
Content-Type: application/json;
BODY
{
                "title":"[title value]"                
                ,"contact":"[contact value]"                
                ,"firstName":"[firstName value]"                
                ,"surname":"[surname value]"                
                ,"email":"[email value]"                
                ,"company":"[company value]"                
                ,"status":"[status value]"                
                ,"phone":"[phone value]"                
                ,"city":"[city value]"                
                ,"country":"[country value]"                
                ,"reply_email":"[reply_email value]"                
                ,"account_manager":"[account_manager value]"                
                ,"reply_name":"[reply_name value]"                
                ,"Record_Manager":"[Record_Manager value]"                
                ,"Address_1":"[Address_1 value]"                
                ,"Address_2":"[Address_2 value]"                
                ,"Address_3":"[Address_3 value]"                
                ,"County":"[County value]"                
                ,"Postcode":"[Postcode value]"                
                ,"Fax":"[Fax value]"                
                ,"Mobile_Phone":"[Mobile_Phone value]"                
                ,"interest":"[interest value]"                
                ,"Last_Name":"[Last_Name value]"                
                ,"Relationship_Status":"[Relationship_Status value]"                
                ,"Company_subtype":"[Company_subtype value]"                
                ,"MGMF_LTD":"[MGMF_LTD value]"                
                ,"MGMF_LLC":"[MGMF_LLC value]"                
    
}
Response Payload
{
    "responseStatus":"Ok",
    "_id":"[the new enitity's _id]"
}

Remove an Entity

By specification, to remove an entity in a collection, the client sends a DELETE request to the contact entity's url.
DELETE http://[root url]/contact/234
HOWEVER, for compatability this action is performed by using a POST with an Action parameter "delete" in the query string
POST http://[root url]/contact/234?Action=delete
Response Payload
{
    "responseStatus":"Ok",
}

Update an Entity

By specification, to update an entity in a collection, the client sends a PUT request to the contact entity's url with the Content-Type "application/json".
PUT http://[root url]/contact/234
Content-Type: application/json;
BODY
{
                "title":"[title value]"                
                ,"contact":"[contact value]"                
                ,"firstName":"[firstName value]"                
                ,"surname":"[surname value]"                
                ,"email":"[email value]"                
                ,"company":"[company value]"                
                ,"status":"[status value]"                
                ,"phone":"[phone value]"                
                ,"city":"[city value]"                
                ,"country":"[country value]"                
                ,"reply_email":"[reply_email value]"                
                ,"account_manager":"[account_manager value]"                
                ,"reply_name":"[reply_name value]"                
                ,"Record_Manager":"[Record_Manager value]"                
                ,"Address_1":"[Address_1 value]"                
                ,"Address_2":"[Address_2 value]"                
                ,"Address_3":"[Address_3 value]"                
                ,"County":"[County value]"                
                ,"Postcode":"[Postcode value]"                
                ,"Fax":"[Fax value]"                
                ,"Mobile_Phone":"[Mobile_Phone value]"                
                ,"interest":"[interest value]"                
                ,"Last_Name":"[Last_Name value]"                
                ,"Relationship_Status":"[Relationship_Status value]"                
                ,"Company_subtype":"[Company_subtype value]"                
                ,"MGMF_LTD":"[MGMF_LTD value]"                
                ,"MGMF_LLC":"[MGMF_LLC value]"                
    
}
HOWEVER, for compatability this action is performed by using a POST with an Action parameter "update" in the query string
POST http://[root url]/contact/234?Action=update
Content-Type: application/json;
BODY
{
                "title":"[title value]"                
                "contact":"[contact value]"                
                "firstName":"[firstName value]"                
                "surname":"[surname value]"                
                "email":"[email value]"                
                "company":"[company value]"                
                "status":"[status value]"                
                "phone":"[phone value]"                
                "city":"[city value]"                
                "country":"[country value]"                
                "reply_email":"[reply_email value]"                
                "account_manager":"[account_manager value]"                
                "reply_name":"[reply_name value]"                
                "Record_Manager":"[Record_Manager value]"                
                "Address_1":"[Address_1 value]"                
                "Address_2":"[Address_2 value]"                
                "Address_3":"[Address_3 value]"                
                "County":"[County value]"                
                "Postcode":"[Postcode value]"                
                "Fax":"[Fax value]"                
                "Mobile_Phone":"[Mobile_Phone value]"                
                "interest":"[interest value]"                
                "Last_Name":"[Last_Name value]"                
                "Relationship_Status":"[Relationship_Status value]"                
                "Company_subtype":"[Company_subtype value]"                
                "MGMF_LTD":"[MGMF_LTD value]"                
                "MGMF_LLC":"[MGMF_LLC value]"                
    
}
Response Payload
{
    "responseStatus":"Ok",
}

contact_distribution_group

contact_distribution_group ...

Requesting Data

The ProFundCom API supports requests for contact_distribution_group data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of contact_distribution_group entities .
GET http://[root url]/contact_distribution_group
Response Payload
{
    "data":[   
                {
                "id":"[id value 1]"                
                ,"user_id":"[user_id value 1]"                
                ,"fund_name":"[fund_name value 1]"                
                ,"fstatus":"[fstatus value 1]"                
                ,"mailing":"[mailing value 1]"                
    
                },
......
                {
                "id":"[id value n]"                
                ,"user_id":"[user_id value n]"                
                ,"fund_name":"[fund_name value n]"                
                ,"fstatus":"[fstatus value n]"                
                ,"mailing":"[mailing value n]"                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • contact_id
For example
GET http://[root url]/contact_distribution_group?contact_id=A%20filter%20value

Requesting an Individual Entity by ID

The request below returns the collection of contact_distribution_group entity identified by id.
GET http://[root url]/contact_distribution_group/234
Response Payload
{
    "data":[   
                {
                "id":"[id value]"                
                ,"user_id":"[user_id value]"                
                ,"fund_name":"[fund_name value]"                
                ,"fstatus":"[fstatus value]"                
                ,"mailing":"[mailing value]"                
    
                }
    ],
    "total":1
}

Data Modification

The ProFundCom API supports Create, Update and Delete operations for contact_distribution_group entities.

Create an Entity

To create an entity in a collection, the client sends a POST request to the contact_distribution_group collection's URL with the Content-Type "application/json". The POST body MUST contain a single valid entity representation. The request below creates a contact_distribution_group.
POST http://[root url]/contact_distribution_group
Content-Type: application/json;
BODY
{
                "id":"[id value]"                
                ,"user_id":"[user_id value (required)]"                
                ,"fund_name":"[fund_name value (required)]"                
                ,"fstatus":"[fstatus value (required)]"                
                ,"mailing":"[mailing value (required)]"                
    
}
Response Payload
{
    "responseStatus":"Ok",
    "id":"[the new enitity's id]"
}

Remove an Entity

By specification, to remove an entity in a collection, the client sends a DELETE request to the contact_distribution_group entity's url.
DELETE http://[root url]/contact_distribution_group/234
HOWEVER, for compatability this action is performed by using a POST with an Action parameter "delete" in the query string
POST http://[root url]/contact_distribution_group/234?Action=delete
Response Payload
{
    "responseStatus":"Ok",
}

Update an Entity

By specification, to update an entity in a collection, the client sends a PUT request to the contact_distribution_group entity's url with the Content-Type "application/json".
PUT http://[root url]/contact_distribution_group/234
Content-Type: application/json;
BODY
{
                "id":"[id value]"                
                ,"user_id":"[user_id value]"                
                ,"fund_name":"[fund_name value]"                
                ,"fstatus":"[fstatus value]"                
                ,"mailing":"[mailing value]"                
    
}
HOWEVER, for compatability this action is performed by using a POST with an Action parameter "update" in the query string
POST http://[root url]/contact_distribution_group/234?Action=update
Content-Type: application/json;
BODY
{
                "id":"[id value]"                
                "user_id":"[user_id value (required)]"                
                "fund_name":"[fund_name value (required)]"                
                "fstatus":"[fstatus value (required)]"                
                "mailing":"[mailing value (required)]"                
    
}
Response Payload
{
    "responseStatus":"Ok",
}

contact_metadata

...

Requesting Data

The ProFundCom API supports requests for contact_metadata data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of entities .
GET http://[root url]/contact_metadata
Response Payload
{
    "data":[   
                {
                "_id":"[_id value 1]"                
                ,"ColumnNo":"[ColumnNo value 1]"                
                ,"FieldName":"[FieldName value 1]"                
                ,"DBDataType":"[DBDataType value 1]"                
                ,"Length":"[Length value 1]"                
                ,"Mapped":"[Mapped value 1]"                
    
                },
......
                {
                "_id":"[_id value n]"                
                ,"ColumnNo":"[ColumnNo value n]"                
                ,"FieldName":"[FieldName value n]"                
                ,"DBDataType":"[DBDataType value n]"                
                ,"Length":"[Length value n]"                
                ,"Mapped":"[Mapped value n]"                
    
                },
    ],
    "total":123
}

Requesting an Individual Entity by ID

The request below returns the collection of contact_metadata entity identified by _id.
GET http://[root url]/contact_metadata/234
Response Payload
{
    "data":[   
                {
                "_id":"[_id value]"                
                ,"ColumnNo":"[ColumnNo value]"                
                ,"FieldName":"[FieldName value]"                
                ,"DBDataType":"[DBDataType value]"                
                ,"Length":"[Length value]"                
                ,"Mapped":"[Mapped value]"                
    
                }
    ],
    "total":1
}

Data Modification

The ProFundCom API supports Create, Update and Delete operations for contact_metadata entities.

Create an Entity

To create an entity in a collection, the client sends a POST request to the contact_metadata collection's URL with the Content-Type "application/json". The POST body MUST contain a single valid entity representation. The request below creates a .
POST http://[root url]/contact_metadata
Content-Type: application/json;
BODY
{
    
}
Response Payload
{
    "responseStatus":"Ok",
    "_id":"[the new enitity's _id]"
}

Remove an Entity

By specification, to remove an entity in a collection, the client sends a DELETE request to the contact_metadata entity's url.
DELETE http://[root url]/contact_metadata/234
HOWEVER, for compatability this action is performed by using a POST with an Action parameter "delete" in the query string
POST http://[root url]/contact_metadata/234?Action=delete
Response Payload
{
    "responseStatus":"Ok",
}

Update an Entity

By specification, to update an entity in a collection, the client sends a PUT request to the contact_metadata entity's url with the Content-Type "application/json".
PUT http://[root url]/contact_metadata/234
Content-Type: application/json;
BODY
{
    
}
HOWEVER, for compatability this action is performed by using a POST with an Action parameter "update" in the query string
POST http://[root url]/contact_metadata/234?Action=update
Content-Type: application/json;
BODY
{
    
}
Response Payload
{
    "responseStatus":"Ok",
}

document

Document ...

Requesting Data

The ProFundCom API supports requests for document data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of Document entities .
GET http://[root url]/document
Response Payload
{
    "data":[   
                {
                "id_files":"[id_files value 1]"                
                ,"user_id":"[user_id value 1]"                
                ,"doc_type":"[doc_type value 1]"                
                ,"doc_active":"[doc_active value 1]"                
                ,"doc_retired":"[doc_retired value 1]"                
                ,"doc_class":"[doc_class value 1]"                
                ,"doc_month":"[doc_month value 1]"                
                ,"doc_year":"[doc_year value 1]"                
                ,"description":"[description value 1]"                
                ,"filesize":"[filesize value 1]"                
                ,"filename":"[filename value 1]"                
                ,"filetype":"[filetype value 1]"                
                ,"new_bin_data":"[new_bin_data value 1]"                
    
                },
......
                {
                "id_files":"[id_files value n]"                
                ,"user_id":"[user_id value n]"                
                ,"doc_type":"[doc_type value n]"                
                ,"doc_active":"[doc_active value n]"                
                ,"doc_retired":"[doc_retired value n]"                
                ,"doc_class":"[doc_class value n]"                
                ,"doc_month":"[doc_month value n]"                
                ,"doc_year":"[doc_year value n]"                
                ,"description":"[description value n]"                
                ,"filesize":"[filesize value n]"                
                ,"filename":"[filename value n]"                
                ,"filetype":"[filetype value n]"                
                ,"new_bin_data":"[new_bin_data value n]"                
    
                },
    ],
    "total":123
}

Requesting an Individual Entity by ID

The request below returns the collection of document entity identified by id_files.
GET http://[root url]/document/234
Response Payload
{
    "data":[   
                {
                "id_files":"[id_files value]"                
                ,"user_id":"[user_id value]"                
                ,"doc_type":"[doc_type value]"                
                ,"doc_active":"[doc_active value]"                
                ,"doc_retired":"[doc_retired value]"                
                ,"doc_class":"[doc_class value]"                
                ,"doc_month":"[doc_month value]"                
                ,"doc_year":"[doc_year value]"                
                ,"description":"[description value]"                
                ,"filesize":"[filesize value]"                
                ,"filename":"[filename value]"                
                ,"filetype":"[filetype value]"                
                ,"new_bin_data":"[new_bin_data value]"                
    
                }
    ],
    "total":1
}

Data Modification

The ProFundCom API supports Create, Update and Delete operations for document entities.

Create an Entity

To create an entity in a collection, the client sends a POST request to the document collection's URL with the Content-Type "application/json". The POST body MUST contain a single valid entity representation. The request below creates a Document.
POST http://[root url]/document
Content-Type: application/json;
BODY
{
                "user_id":"[user_id value]"                
                ,"doc_type":"[doc_type value]"                
                ,"doc_active":"[doc_active value]"                
                ,"doc_retired":"[doc_retired value]"                
                ,"doc_class":"[doc_class value]"                
                ,"doc_month":"[doc_month value]"                
                ,"doc_year":"[doc_year value]"                
                ,"description":"[description value]"                
                ,"filesize":"[filesize value]"                
                ,"filename":"[filename value]"                
                ,"filetype":"[filetype value]"                
    
}
Response Payload
{
    "responseStatus":"Ok",
    "id_files":"[the new enitity's id_files]"
}

Remove an Entity

By specification, to remove an entity in a collection, the client sends a DELETE request to the document entity's url.
DELETE http://[root url]/document/234
HOWEVER, for compatability this action is performed by using a POST with an Action parameter "delete" in the query string
POST http://[root url]/document/234?Action=delete
Response Payload
{
    "responseStatus":"Ok",
}

Update an Entity

By specification, to update an entity in a collection, the client sends a PUT request to the document entity's url with the Content-Type "application/json".
PUT http://[root url]/document/234
Content-Type: application/json;
BODY
{
                "user_id":"[user_id value]"                
                ,"doc_type":"[doc_type value]"                
                ,"doc_active":"[doc_active value]"                
                ,"doc_retired":"[doc_retired value]"                
                ,"doc_class":"[doc_class value]"                
                ,"doc_month":"[doc_month value]"                
                ,"doc_year":"[doc_year value]"                
                ,"description":"[description value]"                
                ,"filesize":"[filesize value]"                
                ,"filename":"[filename value]"                
                ,"filetype":"[filetype value]"                
    
}
HOWEVER, for compatability this action is performed by using a POST with an Action parameter "update" in the query string
POST http://[root url]/document/234?Action=update
Content-Type: application/json;
BODY
{
                "user_id":"[user_id value]"                
                "doc_type":"[doc_type value]"                
                "doc_active":"[doc_active value]"                
                "doc_retired":"[doc_retired value]"                
                "doc_class":"[doc_class value]"                
                "doc_month":"[doc_month value]"                
                "doc_year":"[doc_year value]"                
                "description":"[description value]"                
                "filesize":"[filesize value]"                
                "filename":"[filename value]"                
                "filetype":"[filetype value]"                
    
}
Response Payload
{
    "responseStatus":"Ok",
}

document_stats

document_stats ...

Requesting Data

The ProFundCom API supports requests for document_stats data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of document_stats entities .
GET http://[root url]/document_stats
Response Payload
{
    "data":[   
                {
                "campaign_id":"[campaign_id value 1]"                
                ,"fund_name":"[fund_name value 1]"                
                ,"email":"[email value 1]"                
    
                },
......
                {
                "campaign_id":"[campaign_id value n]"                
                ,"fund_name":"[fund_name value n]"                
                ,"email":"[email value n]"                
    
                },
    ],
    "total":123
}

Data Modification

The ProFundCom API supports Create, Update and Delete operations for document_stats entities.

Create an Entity

To create an entity in a collection, the client sends a POST request to the document_stats collection's URL with the Content-Type "application/json". The POST body MUST contain a single valid entity representation. The request below creates a document_stats.
POST http://[root url]/document_stats
Content-Type: application/json;
BODY
{
                "fund_name":"[fund_name value (required)]"                
                ,"email":"[email value (required)]"                
    
}
Response Payload
{
    "responseStatus":"Ok",
    "":"[the new enitity's ]"
}

Remove an Entity

By specification, to remove an entity in a collection, the client sends a DELETE request to the document_stats entity's url.
DELETE http://[root url]/document_stats/234
HOWEVER, for compatability this action is performed by using a POST with an Action parameter "delete" in the query string
POST http://[root url]/document_stats/234?Action=delete
Response Payload
{
    "responseStatus":"Ok",
}

Update an Entity

By specification, to update an entity in a collection, the client sends a PUT request to the document_stats entity's url with the Content-Type "application/json".
PUT http://[root url]/document_stats/234
Content-Type: application/json;
BODY
{
                "fund_name":"[fund_name value]"                
                ,"email":"[email value]"                
    
}
HOWEVER, for compatability this action is performed by using a POST with an Action parameter "update" in the query string
POST http://[root url]/document_stats/234?Action=update
Content-Type: application/json;
BODY
{
                "fund_name":"[fund_name value (required)]"                
                "email":"[email value (required)]"                
    
}
Response Payload
{
    "responseStatus":"Ok",
}

dynamic_mailing_list

dynamic_mailing_list ...

Requesting Data

The ProFundCom API supports requests for dynamic_mailing_list data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of dynamic_mailing_list entities .
GET http://[root url]/dynamic_mailing_list
Response Payload
{
    "data":[   
                {
                "DynamicMailingListID":"[DynamicMailingListID value 1]"                
                ,"Name":"[Name value 1]"                
    
                },
......
                {
                "DynamicMailingListID":"[DynamicMailingListID value n]"                
                ,"Name":"[Name value n]"                
    
                },
    ],
    "total":123
}

Requesting an Individual Entity by ID

The request below returns the collection of dynamic_mailing_list entity identified by DynamicMailingListID.
GET http://[root url]/dynamic_mailing_list/234
Response Payload
{
    "data":[   
                {
                "DynamicMailingListID":"[DynamicMailingListID value]"                
                ,"Name":"[Name value]"                
    
                }
    ],
    "total":1
}

Data Modification

The ProFundCom API supports Create, Update and Delete operations for dynamic_mailing_list entities.

Create an Entity

To create an entity in a collection, the client sends a POST request to the dynamic_mailing_list collection's URL with the Content-Type "application/json". The POST body MUST contain a single valid entity representation. The request below creates a dynamic_mailing_list.
POST http://[root url]/dynamic_mailing_list
Content-Type: application/json;
BODY
{
    
}
Response Payload
{
    "responseStatus":"Ok",
    "DynamicMailingListID":"[the new enitity's DynamicMailingListID]"
}

Remove an Entity

By specification, to remove an entity in a collection, the client sends a DELETE request to the dynamic_mailing_list entity's url.
DELETE http://[root url]/dynamic_mailing_list/234
HOWEVER, for compatability this action is performed by using a POST with an Action parameter "delete" in the query string
POST http://[root url]/dynamic_mailing_list/234?Action=delete
Response Payload
{
    "responseStatus":"Ok",
}

Update an Entity

By specification, to update an entity in a collection, the client sends a PUT request to the dynamic_mailing_list entity's url with the Content-Type "application/json".
PUT http://[root url]/dynamic_mailing_list/234
Content-Type: application/json;
BODY
{
    
}
HOWEVER, for compatability this action is performed by using a POST with an Action parameter "update" in the query string
POST http://[root url]/dynamic_mailing_list/234?Action=update
Content-Type: application/json;
BODY
{
    
}
Response Payload
{
    "responseStatus":"Ok",
}

email_queue_processed

Email Queue Processes ...

Requesting Data

The ProFundCom API supports requests for email_queue_processed data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of Email Queue Processes entities .
GET http://[root url]/email_queue_processed
Response Payload
{
    "data":[   
                {
                "id":"[id value 1]"                
                ,"myname":"[myname value 1]"                
                ,"myemail":"[myemail value 1]"                
                ,"contactname":"[contactname value 1]"                
                ,"contactemail":"[contactemail value 1]"                
                ,"subject":"[subject value 1]"                
                ,"message":"[message value 1]"                
                ,"status":"[status value 1]"                
                ,"time":"[time value 1]"                
                ,"bcc":"[bcc value 1]"                
                ,"priority":"[priority value 1]"                
                ,"read_receipt":"[read_receipt value 1]"                
                ,"read_receipt_email":"[read_receipt_email value 1]"                
                ,"reply_to":"[reply_to value 1]"                
                ,"attachments":"[attachments value 1]"                
    
                },
......
                {
                "id":"[id value n]"                
                ,"myname":"[myname value n]"                
                ,"myemail":"[myemail value n]"                
                ,"contactname":"[contactname value n]"                
                ,"contactemail":"[contactemail value n]"                
                ,"subject":"[subject value n]"                
                ,"message":"[message value n]"                
                ,"status":"[status value n]"                
                ,"time":"[time value n]"                
                ,"bcc":"[bcc value n]"                
                ,"priority":"[priority value n]"                
                ,"read_receipt":"[read_receipt value n]"                
                ,"read_receipt_email":"[read_receipt_email value n]"                
                ,"reply_to":"[reply_to value n]"                
                ,"attachments":"[attachments value n]"                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • IDGreaterThan
  • DateAfter
  • Email
For example
GET http://[root url]/email_queue_processed?IDGreaterThan=A%20filter%20value

Requesting an Individual Entity by ID

The request below returns the collection of email_queue_processed entity identified by id.
GET http://[root url]/email_queue_processed/234
Response Payload
{
    "data":[   
                {
                "id":"[id value]"                
                ,"myname":"[myname value]"                
                ,"myemail":"[myemail value]"                
                ,"contactname":"[contactname value]"                
                ,"contactemail":"[contactemail value]"                
                ,"subject":"[subject value]"                
                ,"message":"[message value]"                
                ,"status":"[status value]"                
                ,"time":"[time value]"                
                ,"bcc":"[bcc value]"                
                ,"priority":"[priority value]"                
                ,"read_receipt":"[read_receipt value]"                
                ,"read_receipt_email":"[read_receipt_email value]"                
                ,"reply_to":"[reply_to value]"                
                ,"attachments":"[attachments value]"                
    
                }
    ],
    "total":1
}

email_sent

Email Sent ...

Requesting Data

The ProFundCom API supports requests for email_sent data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of Email Sent entities .
GET http://[root url]/email_sent
Response Payload
{
    "data":[   
                {
                "_id":"[_id value 1]"                
                ,"subject":"[subject value 1]"                
                ,"email":"[email value 1]"  // The email address the email was sent to                
                ,"user_id":"[user_id value 1]"  // The internal ID of the ProFundCom user who sent the email                
                ,"owner_name":"[owner_name value 1]"                
                ,"campaign_id":"[campaign_id value 1]"                
                ,"campaign_name":"[campaign_name value 1]"                
                ,"date":"[date value 1]"  // The date and time the email was sent to the email queue                
                ,"email_queue_processed_id":"[email_queue_processed_id value 1]"  // The id of the related email_queue_processed record                
                ,"email_id":"[email_id value 1]"  // The id of the related audit log record - this corresponds with the email_id field in transaction reports, e.g. view_campaign_open                 
    
                },
......
                {
                "_id":"[_id value n]"                
                ,"subject":"[subject value n]"                
                ,"email":"[email value n]"  // The email address the email was sent to                
                ,"user_id":"[user_id value n]"  // The internal ID of the ProFundCom user who sent the email                
                ,"owner_name":"[owner_name value n]"                
                ,"campaign_id":"[campaign_id value n]"                
                ,"campaign_name":"[campaign_name value n]"                
                ,"date":"[date value n]"  // The date and time the email was sent to the email queue                
                ,"email_queue_processed_id":"[email_queue_processed_id value n]"  // The id of the related email_queue_processed record                
                ,"email_id":"[email_id value n]"  // The id of the related audit log record - this corresponds with the email_id field in transaction reports, e.g. view_campaign_open                 
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • IDGreaterThan
  • DateAfter
  • ID
  • Email
  • CampaignID
For example
GET http://[root url]/email_sent?IDGreaterThan=A%20filter%20value

email_sent_with_content

Email Sent With Content ...

Requesting Data

The ProFundCom API supports requests for email_sent_with_content data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of Email Sent With Content entities .
GET http://[root url]/email_sent_with_content
Response Payload
{
    "data":[   
                {
                "_id":"[_id value 1]"                
                ,"subject":"[subject value 1]"                
                ,"email":"[email value 1]"  // The email address the email was sent to                
                ,"user_id":"[user_id value 1]"  // The internal ID of the ProFundCom user who sent the email                
                ,"owner_name":"[owner_name value 1]"                
                ,"campaign_id":"[campaign_id value 1]"                
                ,"campaign_name":"[campaign_name value 1]"                
                ,"date":"[date value 1]"  // The date and time the email was sent to the email queue                
                ,"email_queue_processed_id":"[email_queue_processed_id value 1]"  // The id of the related email_queue_processed record                
                ,"email_id":"[email_id value 1]"  // The id of the related audit log record - this corresponds with the email_id field in transaction reports, e.g. view_campaign_open                 
                ,"message":"[message value 1]"                
    
                },
......
                {
                "_id":"[_id value n]"                
                ,"subject":"[subject value n]"                
                ,"email":"[email value n]"  // The email address the email was sent to                
                ,"user_id":"[user_id value n]"  // The internal ID of the ProFundCom user who sent the email                
                ,"owner_name":"[owner_name value n]"                
                ,"campaign_id":"[campaign_id value n]"                
                ,"campaign_name":"[campaign_name value n]"                
                ,"date":"[date value n]"  // The date and time the email was sent to the email queue                
                ,"email_queue_processed_id":"[email_queue_processed_id value n]"  // The id of the related email_queue_processed record                
                ,"email_id":"[email_id value n]"  // The id of the related audit log record - this corresponds with the email_id field in transaction reports, e.g. view_campaign_open                 
                ,"message":"[message value n]"                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • IDGreaterThan
  • DateAfter
  • ID
  • Email
  • CampaignID
For example
GET http://[root url]/email_sent_with_content?IDGreaterThan=A%20filter%20value

last_month_engagers

Last Month Engagement ...

Requesting Data

The ProFundCom API supports requests for last_month_engagers data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of Last Month Engagement entities by campaign_id.
GET http://[root url]/last_month_engagers/234

Response Payload
{
    "data":[   
                {
                "Name":"[Name value 1]"                
                ,"Email":"[Email value 1]"                
                ,"Company":"[Company value 1]"  // The company associated with the contact                
                ,"Status":"[Status value 1]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value 1]"  // The phone number for the contact                
                ,"City":"[City value 1]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value 1]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value 1]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value 1]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value 1]"                
                ,"tx_id":"[tx_id value 1]"                
                ,"type":"[type value 1]"                
                ,"email_id":"[email_id value 1]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value 1]"                
                ,"Campaign_Name":"[Campaign_Name value 1]"                
                ,"page_visited":"[page_visited value 1]"                
                ,"device":"[device value 1]"                
                ,"broswer":"[broswer value 1]"                
                ,"web_rating":"[web_rating value 1]"                
                ,"campaign_rating":"[campaign_rating value 1]"                
    
                },
......
                {
                "Name":"[Name value n]"                
                ,"Email":"[Email value n]"                
                ,"Company":"[Company value n]"  // The company associated with the contact                
                ,"Status":"[Status value n]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value n]"  // The phone number for the contact                
                ,"City":"[City value n]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value n]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value n]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value n]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value n]"                
                ,"tx_id":"[tx_id value n]"                
                ,"type":"[type value n]"                
                ,"email_id":"[email_id value n]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value n]"                
                ,"Campaign_Name":"[Campaign_Name value n]"                
                ,"page_visited":"[page_visited value n]"                
                ,"device":"[device value n]"                
                ,"broswer":"[broswer value n]"                
                ,"web_rating":"[web_rating value n]"                
                ,"campaign_rating":"[campaign_rating value n]"                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • City
  • TXType
  • ID
  • LessDetail
  • MonthsBack
  • PostFixExcluded
  • AccountManager
For example
GET http://[root url]/last_month_engagers?City=A%20filter%20value

mailing_list

mailing_list ...

Requesting Data

The ProFundCom API supports requests for mailing_list data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of mailing_list entities .
GET http://[root url]/mailing_list
Response Payload
{
    "data":[   
                {
                "mailing_list_id":"[mailing_list_id value 1]"                
                ,"mailing_list_name":"[mailing_list_name value 1]"                
                ,"mailing_list_user":"[mailing_list_user value 1]"                
                ,"mailing_list_date":"[mailing_list_date value 1]"                
    
                },
......
                {
                "mailing_list_id":"[mailing_list_id value n]"                
                ,"mailing_list_name":"[mailing_list_name value n]"                
                ,"mailing_list_user":"[mailing_list_user value n]"                
                ,"mailing_list_date":"[mailing_list_date value n]"                
    
                },
    ],
    "total":123
}

Requesting an Individual Entity by ID

The request below returns the collection of mailing_list entity identified by mailing_list_id.
GET http://[root url]/mailing_list/234
Response Payload
{
    "data":[   
                {
                "mailing_list_id":"[mailing_list_id value]"                
                ,"mailing_list_name":"[mailing_list_name value]"                
                ,"mailing_list_user":"[mailing_list_user value]"                
                ,"mailing_list_date":"[mailing_list_date value]"                
    
                }
    ],
    "total":1
}

Data Modification

The ProFundCom API supports Create, Update and Delete operations for mailing_list entities.

Create an Entity

To create an entity in a collection, the client sends a POST request to the mailing_list collection's URL with the Content-Type "application/json". The POST body MUST contain a single valid entity representation. The request below creates a mailing_list.
POST http://[root url]/mailing_list
Content-Type: application/json;
BODY
{
                "mailing_list_name":"[mailing_list_name value (required)]"                
                ,"mailing_list_date":"[mailing_list_date value]"                
    
}
Response Payload
{
    "responseStatus":"Ok",
    "mailing_list_id":"[the new enitity's mailing_list_id]"
}

Remove an Entity

By specification, to remove an entity in a collection, the client sends a DELETE request to the mailing_list entity's url.
DELETE http://[root url]/mailing_list/234
HOWEVER, for compatability this action is performed by using a POST with an Action parameter "delete" in the query string
POST http://[root url]/mailing_list/234?Action=delete
Response Payload
{
    "responseStatus":"Ok",
}

Update an Entity

By specification, to update an entity in a collection, the client sends a PUT request to the mailing_list entity's url with the Content-Type "application/json".
PUT http://[root url]/mailing_list/234
Content-Type: application/json;
BODY
{
                "mailing_list_name":"[mailing_list_name value]"                
                ,"mailing_list_date":"[mailing_list_date value]"                
    
}
HOWEVER, for compatability this action is performed by using a POST with an Action parameter "update" in the query string
POST http://[root url]/mailing_list/234?Action=update
Content-Type: application/json;
BODY
{
                "mailing_list_name":"[mailing_list_name value (required)]"                
                "mailing_list_date":"[mailing_list_date value]"                
    
}
Response Payload
{
    "responseStatus":"Ok",
}

mailing_list_by_email

mailing_list ...

Requesting Data

The ProFundCom API supports requests for mailing_list_by_email data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of mailing_list entities .
GET http://[root url]/mailing_list_by_email
Response Payload
{
    "data":[   
                {
                "mailing_list_id":"[mailing_list_id value 1]"                
                ,"email":"[email value 1]"                
                ,"mailing_list_tx_id":"[mailing_list_tx_id value 1]"                
    
                },
......
                {
                "mailing_list_id":"[mailing_list_id value n]"                
                ,"email":"[email value n]"                
                ,"mailing_list_tx_id":"[mailing_list_tx_id value n]"                
    
                },
    ],
    "total":123
}

Requesting an Individual Entity by ID

The request below returns the collection of mailing_list_by_email entity identified by email.
GET http://[root url]/mailing_list_by_email/234
Response Payload
{
    "data":[   
                {
                "mailing_list_id":"[mailing_list_id value]"                
                ,"email":"[email value]"                
                ,"mailing_list_tx_id":"[mailing_list_tx_id value]"                
    
                }
    ],
    "total":1
}

Data Modification

The ProFundCom API supports Create, Update and Delete operations for mailing_list_by_email entities.

Create an Entity

To create an entity in a collection, the client sends a POST request to the mailing_list_by_email collection's URL with the Content-Type "application/json". The POST body MUST contain a single valid entity representation. The request below creates a mailing_list.
POST http://[root url]/mailing_list_by_email
Content-Type: application/json;
BODY
{
                "mailing_list_id":"[mailing_list_id value (required)]"                
                ,"email":"[email value (required)]"                
    
}
Response Payload
{
    "responseStatus":"Ok",
    "email":"[the new enitity's email]"
}

Remove an Entity

By specification, to remove an entity in a collection, the client sends a DELETE request to the mailing_list_by_email entity's url.
DELETE http://[root url]/mailing_list_by_email/234
HOWEVER, for compatability this action is performed by using a POST with an Action parameter "delete" in the query string
POST http://[root url]/mailing_list_by_email/234?Action=delete
Response Payload
{
    "responseStatus":"Ok",
}

Update an Entity

By specification, to update an entity in a collection, the client sends a PUT request to the mailing_list_by_email entity's url with the Content-Type "application/json".
PUT http://[root url]/mailing_list_by_email/234
Content-Type: application/json;
BODY
{
                "mailing_list_id":"[mailing_list_id value]"                
                ,"email":"[email value]"                
    
}
HOWEVER, for compatability this action is performed by using a POST with an Action parameter "update" in the query string
POST http://[root url]/mailing_list_by_email/234?Action=update
Content-Type: application/json;
BODY
{
                "mailing_list_id":"[mailing_list_id value (required)]"                
                "email":"[email value (required)]"                
    
}
Response Payload
{
    "responseStatus":"Ok",
}

mailing_list_member

mailing_list_member ...

Requesting Data

The ProFundCom API supports requests for mailing_list_member data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of mailing_list_member entities belonging to a parent mailing_list entity.
GET http://[root url]/mailing_list/234/mailing_list_member
Response Payload
{
    "data":[   
                {
                "mailing_list_id":"[mailing_list_id value 1]"                
                ,"email":"[email value 1]"                
                ,"mailing_list_tx_id":"[mailing_list_tx_id value 1]"                
                ,"unsubscribe":"[unsubscribe value 1]"                
    
                },
......
                {
                "mailing_list_id":"[mailing_list_id value n]"                
                ,"email":"[email value n]"                
                ,"mailing_list_tx_id":"[mailing_list_tx_id value n]"                
                ,"unsubscribe":"[unsubscribe value n]"                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • mailing_list_id
  • email
For example
GET http://[root url]/mailing_list/234/mailing_list_member?mailing_list_id=A%20filter%20value

Requesting an Individual Entity by ID

The request below returns the collection of mailing_list_member entity identified by mailing_list_tx_id.
GET http://[root url]/mailing_list_member/234
Response Payload
{
    "data":[   
                {
                "mailing_list_id":"[mailing_list_id value]"                
                ,"email":"[email value]"                
                ,"mailing_list_tx_id":"[mailing_list_tx_id value]"                
                ,"unsubscribe":"[unsubscribe value]"                
    
                }
    ],
    "total":1
}

Data Modification

The ProFundCom API supports Create, Update and Delete operations for mailing_list_member entities.

Create an Entity

To create an entity in a collection, the client sends a POST request to the mailing_list_member collection's URL belonging to a parent mailing_list entity with the Content-Type "application/json". The POST body MUST contain a single valid entity representation. The request below creates a mailing_list_member.
POST http://[root url]/mailing_list/234/mailing_list_member
Content-Type: application/json;
BODY
{
                "email":"[email value (required)]"                
                ,"unsubscribe":"[unsubscribe value (required)]"                
    
}
Response Payload
{
    "responseStatus":"Ok",
    "mailing_list_tx_id":"[the new enitity's mailing_list_tx_id]"
}

Remove an Entity

By specification, to remove an entity in a collection, the client sends a DELETE request to the mailing_list_member entity's url.
DELETE http://[root url]/mailing_list_member/234
HOWEVER, for compatability this action is performed by using a POST with an Action parameter "delete" in the query string
POST http://[root url]/mailing_list_member/234?Action=delete
Response Payload
{
    "responseStatus":"Ok",
}

Update an Entity

By specification, to update an entity in a collection, the client sends a PUT request to the mailing_list_member entity's url with the Content-Type "application/json".
PUT http://[root url]/mailing_list_member/234
Content-Type: application/json;
BODY
{
                "mailing_list_id":"[mailing_list_id value]"                
                ,"email":"[email value]"                
                ,"unsubscribe":"[unsubscribe value]"                
    
}
HOWEVER, for compatability this action is performed by using a POST with an Action parameter "update" in the query string
POST http://[root url]/mailing_list_member/234?Action=update
Content-Type: application/json;
BODY
{
                "mailing_list_id":"[mailing_list_id value (required)]"                
                "email":"[email value (required)]"                
                "unsubscribe":"[unsubscribe value (required)]"                
    
}
Response Payload
{
    "responseStatus":"Ok",
}

notes

notes ...

Requesting Data

The ProFundCom API supports requests for notes data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of notes entities .
GET http://[root url]/notes
Response Payload
{
    "data":[   
                {
                "id":"[id value 1]"                
                ,"note":"[note value 1]"                
                ,"author":"[author value 1]"                
                ,"email":"[email value 1]"                
                ,"date":"[date value 1]"                
    
                },
......
                {
                "id":"[id value n]"                
                ,"note":"[note value n]"                
                ,"author":"[author value n]"                
                ,"email":"[email value n]"                
                ,"date":"[date value n]"                
    
                },
    ],
    "total":123
}

Requesting an Individual Entity by ID

The request below returns the collection of notes entity identified by email.
GET http://[root url]/notes/234
Response Payload
{
    "data":[   
                {
                "id":"[id value]"                
                ,"note":"[note value]"                
                ,"author":"[author value]"                
                ,"email":"[email value]"                
                ,"date":"[date value]"                
    
                }
    ],
    "total":1
}

Data Modification

The ProFundCom API supports Create, Update and Delete operations for notes entities.

Create an Entity

To create an entity in a collection, the client sends a POST request to the notes collection's URL with the Content-Type "application/json". The POST body MUST contain a single valid entity representation. The request below creates a notes.
POST http://[root url]/notes
Content-Type: application/json;
BODY
{
                "note":"[note value (required)]"                
                ,"author":"[author value (required)]"                
                ,"email":"[email value (required)]"                
                ,"date":"[date value (required)]"                
    
}
Response Payload
{
    "responseStatus":"Ok",
    "email":"[the new enitity's email]"
}

Remove an Entity

By specification, to remove an entity in a collection, the client sends a DELETE request to the notes entity's url.
DELETE http://[root url]/notes/234
HOWEVER, for compatability this action is performed by using a POST with an Action parameter "delete" in the query string
POST http://[root url]/notes/234?Action=delete
Response Payload
{
    "responseStatus":"Ok",
}

Update an Entity

By specification, to update an entity in a collection, the client sends a PUT request to the notes entity's url with the Content-Type "application/json".
PUT http://[root url]/notes/234
Content-Type: application/json;
BODY
{
                "note":"[note value]"                
                ,"author":"[author value]"                
                ,"email":"[email value]"                
                ,"date":"[date value]"                
    
}
HOWEVER, for compatability this action is performed by using a POST with an Action parameter "update" in the query string
POST http://[root url]/notes/234?Action=update
Content-Type: application/json;
BODY
{
                "note":"[note value (required)]"                
                "author":"[author value (required)]"                
                "email":"[email value (required)]"                
                "date":"[date value (required)]"                
    
}
Response Payload
{
    "responseStatus":"Ok",
}

template

template ...

Requesting Data

The ProFundCom API supports requests for template data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of template entities .
GET http://[root url]/template
Response Payload
{
    "data":[   
                {
                "template_id":"[template_id value 1]"                
                ,"author_id":"[author_id value 1]"                
                ,"template_approved":"[template_approved value 1]"                
                ,"template_name":"[template_name value 1]"                
                ,"template_subject":"[template_subject value 1]"                
                ,"template_salutation":"[template_salutation value 1]"                
                ,"template_salutation_activate":"[template_salutation_activate value 1]"                
                ,"template_salutation_empty":"[template_salutation_empty value 1]"                
                ,"template_para_first":"[template_para_first value 1]"                
                ,"template_para_last":"[template_para_last value 1]"                
                ,"template_image_path":"[template_image_path value 1]"                
                ,"template_target":"[template_target value 1]"                
                ,"template_priority":"[template_priority value 1]"                
                ,"template_rr":"[template_rr value 1]"                
                ,"template_rr_email":"[template_rr_email value 1]"                
                ,"template_from_email":"[template_from_email value 1]"                
                ,"template_from_name":"[template_from_name value 1]"                
                ,"template_reply_email":"[template_reply_email value 1]"                
                ,"template_cc_email":"[template_cc_email value 1]"                
                ,"template_bcc_email":"[template_bcc_email value 1]"                
                ,"template_font":"[template_font value 1]"                
                ,"template_font_size":"[template_font_size value 1]"                
                ,"template_campaign_id":"[template_campaign_id value 1]"                
                ,"template_campaign_activate":"[template_campaign_activate value 1]"                
                ,"template_retired":"[template_retired value 1]"                
                ,"date_submitted":"[date_submitted value 1]"                
                ,"template_locked":"[template_locked value 1]"                
                ,"template_locked_by":"[template_locked_by value 1]"                
                ,"template_locked_at":"[template_locked_at value 1]"                
                ,"template_modified_by":"[template_modified_by value 1]"                
                ,"template_modified_at":"[template_modified_at value 1]"                
                ,"template_stamp_x":"[template_stamp_x value 1]"                
                ,"template_stamp_y":"[template_stamp_y value 1]"                
                ,"template_stamp_z":"[template_stamp_z value 1]"                
                ,"template_stamp_l":"[template_stamp_l value 1]"                
                ,"template_stamp_page":"[template_stamp_page value 1]"                
                ,"template_stamp_mode":"[template_stamp_mode value 1]"                
                ,"template_stamp_pretext":"[template_stamp_pretext value 1]"                
                ,"template_error":"[template_error value 1]"                
                ,"template_error_text":"[template_error_text value 1]"                
                ,"template_automate":"[template_automate value 1]"                
                ,"template_master":"[template_master value 1]"                
                ,"template_master_image":"[template_master_image value 1]"                
                ,"template_factory":"[template_factory value 1]"                
                ,"fail_if_no_conditional_content":"[fail_if_no_conditional_content value 1]"                
                ,"not_editable":"[not_editable value 1]"                
    
                },
......
                {
                "template_id":"[template_id value n]"                
                ,"author_id":"[author_id value n]"                
                ,"template_approved":"[template_approved value n]"                
                ,"template_name":"[template_name value n]"                
                ,"template_subject":"[template_subject value n]"                
                ,"template_salutation":"[template_salutation value n]"                
                ,"template_salutation_activate":"[template_salutation_activate value n]"                
                ,"template_salutation_empty":"[template_salutation_empty value n]"                
                ,"template_para_first":"[template_para_first value n]"                
                ,"template_para_last":"[template_para_last value n]"                
                ,"template_image_path":"[template_image_path value n]"                
                ,"template_target":"[template_target value n]"                
                ,"template_priority":"[template_priority value n]"                
                ,"template_rr":"[template_rr value n]"                
                ,"template_rr_email":"[template_rr_email value n]"                
                ,"template_from_email":"[template_from_email value n]"                
                ,"template_from_name":"[template_from_name value n]"                
                ,"template_reply_email":"[template_reply_email value n]"                
                ,"template_cc_email":"[template_cc_email value n]"                
                ,"template_bcc_email":"[template_bcc_email value n]"                
                ,"template_font":"[template_font value n]"                
                ,"template_font_size":"[template_font_size value n]"                
                ,"template_campaign_id":"[template_campaign_id value n]"                
                ,"template_campaign_activate":"[template_campaign_activate value n]"                
                ,"template_retired":"[template_retired value n]"                
                ,"date_submitted":"[date_submitted value n]"                
                ,"template_locked":"[template_locked value n]"                
                ,"template_locked_by":"[template_locked_by value n]"                
                ,"template_locked_at":"[template_locked_at value n]"                
                ,"template_modified_by":"[template_modified_by value n]"                
                ,"template_modified_at":"[template_modified_at value n]"                
                ,"template_stamp_x":"[template_stamp_x value n]"                
                ,"template_stamp_y":"[template_stamp_y value n]"                
                ,"template_stamp_z":"[template_stamp_z value n]"                
                ,"template_stamp_l":"[template_stamp_l value n]"                
                ,"template_stamp_page":"[template_stamp_page value n]"                
                ,"template_stamp_mode":"[template_stamp_mode value n]"                
                ,"template_stamp_pretext":"[template_stamp_pretext value n]"                
                ,"template_error":"[template_error value n]"                
                ,"template_error_text":"[template_error_text value n]"                
                ,"template_automate":"[template_automate value n]"                
                ,"template_master":"[template_master value n]"                
                ,"template_master_image":"[template_master_image value n]"                
                ,"template_factory":"[template_factory value n]"                
                ,"fail_if_no_conditional_content":"[fail_if_no_conditional_content value n]"                
                ,"not_editable":"[not_editable value n]"                
    
                },
    ],
    "total":123
}

Requesting an Individual Entity by ID

The request below returns the collection of template entity identified by template_id.
GET http://[root url]/template/234
Response Payload
{
    "data":[   
                {
                "template_id":"[template_id value]"                
                ,"author_id":"[author_id value]"                
                ,"template_approved":"[template_approved value]"                
                ,"template_name":"[template_name value]"                
                ,"template_subject":"[template_subject value]"                
                ,"template_salutation":"[template_salutation value]"                
                ,"template_salutation_activate":"[template_salutation_activate value]"                
                ,"template_salutation_empty":"[template_salutation_empty value]"                
                ,"template_para_first":"[template_para_first value]"                
                ,"template_para_last":"[template_para_last value]"                
                ,"template_image_path":"[template_image_path value]"                
                ,"template_target":"[template_target value]"                
                ,"template_priority":"[template_priority value]"                
                ,"template_rr":"[template_rr value]"                
                ,"template_rr_email":"[template_rr_email value]"                
                ,"template_from_email":"[template_from_email value]"                
                ,"template_from_name":"[template_from_name value]"                
                ,"template_reply_email":"[template_reply_email value]"                
                ,"template_cc_email":"[template_cc_email value]"                
                ,"template_bcc_email":"[template_bcc_email value]"                
                ,"template_font":"[template_font value]"                
                ,"template_font_size":"[template_font_size value]"                
                ,"template_campaign_id":"[template_campaign_id value]"                
                ,"template_campaign_activate":"[template_campaign_activate value]"                
                ,"template_retired":"[template_retired value]"                
                ,"date_submitted":"[date_submitted value]"                
                ,"template_locked":"[template_locked value]"                
                ,"template_locked_by":"[template_locked_by value]"                
                ,"template_locked_at":"[template_locked_at value]"                
                ,"template_modified_by":"[template_modified_by value]"                
                ,"template_modified_at":"[template_modified_at value]"                
                ,"template_stamp_x":"[template_stamp_x value]"                
                ,"template_stamp_y":"[template_stamp_y value]"                
                ,"template_stamp_z":"[template_stamp_z value]"                
                ,"template_stamp_l":"[template_stamp_l value]"                
                ,"template_stamp_page":"[template_stamp_page value]"                
                ,"template_stamp_mode":"[template_stamp_mode value]"                
                ,"template_stamp_pretext":"[template_stamp_pretext value]"                
                ,"template_error":"[template_error value]"                
                ,"template_error_text":"[template_error_text value]"                
                ,"template_automate":"[template_automate value]"                
                ,"template_master":"[template_master value]"                
                ,"template_master_image":"[template_master_image value]"                
                ,"template_factory":"[template_factory value]"                
                ,"fail_if_no_conditional_content":"[fail_if_no_conditional_content value]"                
                ,"not_editable":"[not_editable value]"                
    
                }
    ],
    "total":1
}

Data Modification

The ProFundCom API supports Create, Update and Delete operations for template entities.

Create an Entity

To create an entity in a collection, the client sends a POST request to the template collection's URL with the Content-Type "application/json". The POST body MUST contain a single valid entity representation. The request below creates a template.
POST http://[root url]/template
Content-Type: application/json;
BODY
{
                "author_id":"[author_id value]"                
                ,"template_approved":"[template_approved value]"                
                ,"template_name":"[template_name value]"                
                ,"template_subject":"[template_subject value]"                
                ,"template_salutation":"[template_salutation value]"                
                ,"template_salutation_activate":"[template_salutation_activate value]"                
                ,"template_salutation_empty":"[template_salutation_empty value]"                
                ,"template_para_first":"[template_para_first value]"                
                ,"template_para_last":"[template_para_last value]"                
                ,"template_image_path":"[template_image_path value]"                
                ,"template_target":"[template_target value]"                
                ,"template_priority":"[template_priority value]"                
                ,"template_rr":"[template_rr value]"                
                ,"template_rr_email":"[template_rr_email value]"                
                ,"template_from_email":"[template_from_email value]"                
                ,"template_from_name":"[template_from_name value]"                
                ,"template_reply_email":"[template_reply_email value]"                
                ,"template_cc_email":"[template_cc_email value]"                
                ,"template_bcc_email":"[template_bcc_email value]"                
                ,"template_font":"[template_font value]"                
                ,"template_font_size":"[template_font_size value]"                
                ,"template_campaign_id":"[template_campaign_id value]"                
                ,"template_campaign_activate":"[template_campaign_activate value]"                
                ,"template_retired":"[template_retired value]"                
                ,"date_submitted":"[date_submitted value]"                
                ,"template_locked":"[template_locked value]"                
                ,"template_locked_by":"[template_locked_by value]"                
                ,"template_locked_at":"[template_locked_at value]"                
                ,"template_modified_by":"[template_modified_by value]"                
                ,"template_modified_at":"[template_modified_at value]"                
                ,"template_stamp_x":"[template_stamp_x value]"                
                ,"template_stamp_y":"[template_stamp_y value]"                
                ,"template_stamp_z":"[template_stamp_z value]"                
                ,"template_stamp_l":"[template_stamp_l value]"                
                ,"template_stamp_page":"[template_stamp_page value]"                
                ,"template_stamp_mode":"[template_stamp_mode value]"                
                ,"template_stamp_pretext":"[template_stamp_pretext value]"                
                ,"template_error":"[template_error value]"                
                ,"template_error_text":"[template_error_text value]"                
                ,"template_automate":"[template_automate value]"                
                ,"template_master":"[template_master value]"                
                ,"template_master_image":"[template_master_image value]"                
                ,"template_factory":"[template_factory value]"                
                ,"fail_if_no_conditional_content":"[fail_if_no_conditional_content value]"                
                ,"not_editable":"[not_editable value]"                
    
}
Response Payload
{
    "responseStatus":"Ok",
    "template_id":"[the new enitity's template_id]"
}

Remove an Entity

By specification, to remove an entity in a collection, the client sends a DELETE request to the template entity's url.
DELETE http://[root url]/template/234
HOWEVER, for compatability this action is performed by using a POST with an Action parameter "delete" in the query string
POST http://[root url]/template/234?Action=delete
Response Payload
{
    "responseStatus":"Ok",
}

Update an Entity

By specification, to update an entity in a collection, the client sends a PUT request to the template entity's url with the Content-Type "application/json".
PUT http://[root url]/template/234
Content-Type: application/json;
BODY
{
                "author_id":"[author_id value]"                
                ,"template_approved":"[template_approved value]"                
                ,"template_name":"[template_name value]"                
                ,"template_subject":"[template_subject value]"                
                ,"template_salutation":"[template_salutation value]"                
                ,"template_salutation_activate":"[template_salutation_activate value]"                
                ,"template_salutation_empty":"[template_salutation_empty value]"                
                ,"template_para_first":"[template_para_first value]"                
                ,"template_para_last":"[template_para_last value]"                
                ,"template_image_path":"[template_image_path value]"                
                ,"template_target":"[template_target value]"                
                ,"template_priority":"[template_priority value]"                
                ,"template_rr":"[template_rr value]"                
                ,"template_rr_email":"[template_rr_email value]"                
                ,"template_from_email":"[template_from_email value]"                
                ,"template_from_name":"[template_from_name value]"                
                ,"template_reply_email":"[template_reply_email value]"                
                ,"template_cc_email":"[template_cc_email value]"                
                ,"template_bcc_email":"[template_bcc_email value]"                
                ,"template_font":"[template_font value]"                
                ,"template_font_size":"[template_font_size value]"                
                ,"template_campaign_id":"[template_campaign_id value]"                
                ,"template_campaign_activate":"[template_campaign_activate value]"                
                ,"template_retired":"[template_retired value]"                
                ,"date_submitted":"[date_submitted value]"                
                ,"template_locked":"[template_locked value]"                
                ,"template_locked_by":"[template_locked_by value]"                
                ,"template_locked_at":"[template_locked_at value]"                
                ,"template_modified_by":"[template_modified_by value]"                
                ,"template_modified_at":"[template_modified_at value]"                
                ,"template_stamp_x":"[template_stamp_x value]"                
                ,"template_stamp_y":"[template_stamp_y value]"                
                ,"template_stamp_z":"[template_stamp_z value]"                
                ,"template_stamp_l":"[template_stamp_l value]"                
                ,"template_stamp_page":"[template_stamp_page value]"                
                ,"template_stamp_mode":"[template_stamp_mode value]"                
                ,"template_stamp_pretext":"[template_stamp_pretext value]"                
                ,"template_error":"[template_error value]"                
                ,"template_error_text":"[template_error_text value]"                
                ,"template_automate":"[template_automate value]"                
                ,"template_master":"[template_master value]"                
                ,"template_master_image":"[template_master_image value]"                
                ,"template_factory":"[template_factory value]"                
                ,"fail_if_no_conditional_content":"[fail_if_no_conditional_content value]"                
                ,"not_editable":"[not_editable value]"                
    
}
HOWEVER, for compatability this action is performed by using a POST with an Action parameter "update" in the query string
POST http://[root url]/template/234?Action=update
Content-Type: application/json;
BODY
{
                "author_id":"[author_id value]"                
                "template_approved":"[template_approved value]"                
                "template_name":"[template_name value]"                
                "template_subject":"[template_subject value]"                
                "template_salutation":"[template_salutation value]"                
                "template_salutation_activate":"[template_salutation_activate value]"                
                "template_salutation_empty":"[template_salutation_empty value]"                
                "template_para_first":"[template_para_first value]"                
                "template_para_last":"[template_para_last value]"                
                "template_image_path":"[template_image_path value]"                
                "template_target":"[template_target value]"                
                "template_priority":"[template_priority value]"                
                "template_rr":"[template_rr value]"                
                "template_rr_email":"[template_rr_email value]"                
                "template_from_email":"[template_from_email value]"                
                "template_from_name":"[template_from_name value]"                
                "template_reply_email":"[template_reply_email value]"                
                "template_cc_email":"[template_cc_email value]"                
                "template_bcc_email":"[template_bcc_email value]"                
                "template_font":"[template_font value]"                
                "template_font_size":"[template_font_size value]"                
                "template_campaign_id":"[template_campaign_id value]"                
                "template_campaign_activate":"[template_campaign_activate value]"                
                "template_retired":"[template_retired value]"                
                "date_submitted":"[date_submitted value]"                
                "template_locked":"[template_locked value]"                
                "template_locked_by":"[template_locked_by value]"                
                "template_locked_at":"[template_locked_at value]"                
                "template_modified_by":"[template_modified_by value]"                
                "template_modified_at":"[template_modified_at value]"                
                "template_stamp_x":"[template_stamp_x value]"                
                "template_stamp_y":"[template_stamp_y value]"                
                "template_stamp_z":"[template_stamp_z value]"                
                "template_stamp_l":"[template_stamp_l value]"                
                "template_stamp_page":"[template_stamp_page value]"                
                "template_stamp_mode":"[template_stamp_mode value]"                
                "template_stamp_pretext":"[template_stamp_pretext value]"                
                "template_error":"[template_error value]"                
                "template_error_text":"[template_error_text value]"                
                "template_automate":"[template_automate value]"                
                "template_master":"[template_master value]"                
                "template_master_image":"[template_master_image value]"                
                "template_factory":"[template_factory value]"                
                "fail_if_no_conditional_content":"[fail_if_no_conditional_content value]"                
                "not_editable":"[not_editable value]"                
    
}
Response Payload
{
    "responseStatus":"Ok",
}

view_bounced_list

View Bounced List ...

Requesting Data

The ProFundCom API supports requests for view_bounced_list data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of View Bounced List entities .
GET http://[root url]/view_bounced_list
Response Payload
{
    "data":[   
                {
                "Actions":"[Actions value 1]"                
                ,"Email":"[Email value 1]"                
                ,"First_Bounce":"[First_Bounce value 1]"                
                ,"Last_Bounce":"[Last_Bounce value 1]"                
                ,"Reason":"[Reason value 1]"                
                ,"BounceID":"[BounceID value 1]"                
                ,"Account_Manager":"[Account_Manager value 1]"  // The account manager defined for the contact based on the mapping for account manager                
    
                },
......
                {
                "Actions":"[Actions value n]"                
                ,"Email":"[Email value n]"                
                ,"First_Bounce":"[First_Bounce value n]"                
                ,"Last_Bounce":"[Last_Bounce value n]"                
                ,"Reason":"[Reason value n]"                
                ,"BounceID":"[BounceID value n]"                
                ,"Account_Manager":"[Account_Manager value n]"  // The account manager defined for the contact based on the mapping for account manager                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • IDGreaterThan
For example
GET http://[root url]/view_bounced_list?IDGreaterThan=A%20filter%20value

view_campaign_all

View Campaign All Engagements ...

Requesting Data

The ProFundCom API supports requests for view_campaign_all data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of View Campaign All Engagements entities by campaign_id.
GET http://[root url]/view_campaign_all/234

Response Payload
{
    "data":[   
                {
                "Name":"[Name value 1]"                
                ,"Email":"[Email value 1]"                
                ,"Company":"[Company value 1]"  // The company associated with the contact                
                ,"Status":"[Status value 1]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value 1]"  // The phone number for the contact                
                ,"City":"[City value 1]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value 1]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value 1]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value 1]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value 1]"                
                ,"tx_id":"[tx_id value 1]"                
                ,"type":"[type value 1]"                
                ,"email_id":"[email_id value 1]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value 1]"                
                ,"Campaign_Name":"[Campaign_Name value 1]"                
                ,"page_visited":"[page_visited value 1]"                
                ,"device":"[device value 1]"                
                ,"broswer":"[broswer value 1]"                
    
                },
......
                {
                "Name":"[Name value n]"                
                ,"Email":"[Email value n]"                
                ,"Company":"[Company value n]"  // The company associated with the contact                
                ,"Status":"[Status value n]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value n]"  // The phone number for the contact                
                ,"City":"[City value n]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value n]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value n]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value n]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value n]"                
                ,"tx_id":"[tx_id value n]"                
                ,"type":"[type value n]"                
                ,"email_id":"[email_id value n]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value n]"                
                ,"Campaign_Name":"[Campaign_Name value n]"                
                ,"page_visited":"[page_visited value n]"                
                ,"device":"[device value n]"                
                ,"broswer":"[broswer value n]"                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • email_id
  • Email
  • TXIDGreaterThan
  • DateAfter
  • TXType
  • PostFixExcluded
For example
GET http://[root url]/view_campaign_all?email_id=A%20filter%20value

view_campaign_all_email

View Campaign All Email Engagements ...

Requesting Data

The ProFundCom API supports requests for view_campaign_all_email data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of View Campaign All Email Engagements entities by campaign_id.
GET http://[root url]/view_campaign_all_email/234

Response Payload
{
    "data":[   
                {
                "Name":"[Name value 1]"                
                ,"Email":"[Email value 1]"                
                ,"Company":"[Company value 1]"  // The company associated with the contact                
                ,"Status":"[Status value 1]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value 1]"  // The phone number for the contact                
                ,"City":"[City value 1]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value 1]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value 1]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value 1]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value 1]"                
                ,"tx_id":"[tx_id value 1]"                
                ,"type":"[type value 1]"                
                ,"email_id":"[email_id value 1]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value 1]"                
                ,"Campaign_Name":"[Campaign_Name value 1]"                
                ,"page_visited":"[page_visited value 1]"                
                ,"device":"[device value 1]"                
                ,"broswer":"[broswer value 1]"                
    
                },
......
                {
                "Name":"[Name value n]"                
                ,"Email":"[Email value n]"                
                ,"Company":"[Company value n]"  // The company associated with the contact                
                ,"Status":"[Status value n]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value n]"  // The phone number for the contact                
                ,"City":"[City value n]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value n]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value n]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value n]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value n]"                
                ,"tx_id":"[tx_id value n]"                
                ,"type":"[type value n]"                
                ,"email_id":"[email_id value n]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value n]"                
                ,"Campaign_Name":"[Campaign_Name value n]"                
                ,"page_visited":"[page_visited value n]"                
                ,"device":"[device value n]"                
                ,"broswer":"[broswer value n]"                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • email_id
  • Email
  • TXIDGreaterThan
  • DateAfter
  • TXType
  • PostFixExcluded
For example
GET http://[root url]/view_campaign_all_email?email_id=A%20filter%20value

view_campaign_all_email_unique

View Campaign Email Engagements Unique ...

Requesting Data

The ProFundCom API supports requests for view_campaign_all_email_unique data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of View Campaign Email Engagements Unique entities by campaign_id.
GET http://[root url]/view_campaign_all_email_unique/234

Response Payload
{
    "data":[   
                {
                "Name":"[Name value 1]"                
                ,"Email":"[Email value 1]"                
                ,"Company":"[Company value 1]"  // The company associated with the contact                
                ,"Status":"[Status value 1]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value 1]"  // The phone number for the contact                
                ,"City":"[City value 1]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value 1]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value 1]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"campaign_id":"[campaign_id value 1]"                
                ,"email_id":"[email_id value 1]"                
                ,"Campaign_Name":"[Campaign_Name value 1]"                
                ,"last_device":"[last_device value 1]"                
                ,"last_broswer":"[last_broswer value 1]"                
                ,"Engagements":"[Engagements value 1]"                
                ,"InitialID":"[InitialID value 1]"                
                ,"LastID":"[LastID value 1]"                
                ,"HighestInteraction":"[HighestInteraction value 1]"                
                ,"EarliestDate":"[EarliestDate value 1]"                
                ,"LatestDate":"[LatestDate value 1]"                
    
                },
......
                {
                "Name":"[Name value n]"                
                ,"Email":"[Email value n]"                
                ,"Company":"[Company value n]"  // The company associated with the contact                
                ,"Status":"[Status value n]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value n]"  // The phone number for the contact                
                ,"City":"[City value n]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value n]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value n]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"campaign_id":"[campaign_id value n]"                
                ,"email_id":"[email_id value n]"                
                ,"Campaign_Name":"[Campaign_Name value n]"                
                ,"last_device":"[last_device value n]"                
                ,"last_broswer":"[last_broswer value n]"                
                ,"Engagements":"[Engagements value n]"                
                ,"InitialID":"[InitialID value n]"                
                ,"LastID":"[LastID value n]"                
                ,"HighestInteraction":"[HighestInteraction value n]"                
                ,"EarliestDate":"[EarliestDate value n]"                
                ,"LatestDate":"[LatestDate value n]"                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • email_id
  • Email
  • TXIDGreaterThan
  • DateAfter
  • TXType
  • PostFixExcluded
For example
GET http://[root url]/view_campaign_all_email_unique?email_id=A%20filter%20value

view_campaign_forward

View Campaign Forward Engagements ...

Requesting Data

The ProFundCom API supports requests for view_campaign_forward data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of View Campaign Forward Engagements entities by campaign_id.
GET http://[root url]/view_campaign_forward/234

Response Payload
{
    "data":[   
                {
                "Name":"[Name value 1]"                
                ,"Email":"[Email value 1]"                
                ,"Company":"[Company value 1]"  // The company associated with the contact                
                ,"Status":"[Status value 1]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value 1]"  // The phone number for the contact                
                ,"City":"[City value 1]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value 1]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value 1]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value 1]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value 1]"                
                ,"tx_id":"[tx_id value 1]"                
                ,"type":"[type value 1]"                
                ,"email_id":"[email_id value 1]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value 1]"                
                ,"Campaign_Name":"[Campaign_Name value 1]"                
                ,"page_visited":"[page_visited value 1]"                
                ,"device":"[device value 1]"                
                ,"broswer":"[broswer value 1]"                
    
                },
......
                {
                "Name":"[Name value n]"                
                ,"Email":"[Email value n]"                
                ,"Company":"[Company value n]"  // The company associated with the contact                
                ,"Status":"[Status value n]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value n]"  // The phone number for the contact                
                ,"City":"[City value n]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value n]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value n]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value n]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value n]"                
                ,"tx_id":"[tx_id value n]"                
                ,"type":"[type value n]"                
                ,"email_id":"[email_id value n]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value n]"                
                ,"Campaign_Name":"[Campaign_Name value n]"                
                ,"page_visited":"[page_visited value n]"                
                ,"device":"[device value n]"                
                ,"broswer":"[broswer value n]"                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • email_id
  • Email
  • TXIDGreaterThan
  • DateAfter
  • TXType
  • PostFixExcluded
For example
GET http://[root url]/view_campaign_forward?email_id=A%20filter%20value

view_campaign_forward_unique

View Campaign Forward Engagements ...

Requesting Data

The ProFundCom API supports requests for view_campaign_forward_unique data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of View Campaign Forward Engagements entities by campaign_id.
GET http://[root url]/view_campaign_forward_unique/234

Response Payload
{
    "data":[   
                {
                "Name":"[Name value 1]"                
                ,"Email":"[Email value 1]"                
                ,"Company":"[Company value 1]"  // The company associated with the contact                
                ,"Status":"[Status value 1]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value 1]"  // The phone number for the contact                
                ,"City":"[City value 1]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value 1]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value 1]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value 1]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value 1]"                
                ,"tx_id":"[tx_id value 1]"                
                ,"type":"[type value 1]"                
                ,"email_id":"[email_id value 1]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value 1]"                
                ,"Campaign_Name":"[Campaign_Name value 1]"                
                ,"page_visited":"[page_visited value 1]"                
                ,"device":"[device value 1]"                
                ,"broswer":"[broswer value 1]"                
                ,"Engagements":"[Engagements value 1]"                
    
                },
......
                {
                "Name":"[Name value n]"                
                ,"Email":"[Email value n]"                
                ,"Company":"[Company value n]"  // The company associated with the contact                
                ,"Status":"[Status value n]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value n]"  // The phone number for the contact                
                ,"City":"[City value n]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value n]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value n]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value n]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value n]"                
                ,"tx_id":"[tx_id value n]"                
                ,"type":"[type value n]"                
                ,"email_id":"[email_id value n]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value n]"                
                ,"Campaign_Name":"[Campaign_Name value n]"                
                ,"page_visited":"[page_visited value n]"                
                ,"device":"[device value n]"                
                ,"broswer":"[broswer value n]"                
                ,"Engagements":"[Engagements value n]"                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • email_id
  • Email
  • TXIDGreaterThan
  • DateAfter
  • TXType
  • PostFixExcluded
For example
GET http://[root url]/view_campaign_forward_unique?email_id=A%20filter%20value

view_campaign_open

View Campaign Open ...

Requesting Data

The ProFundCom API supports requests for view_campaign_open data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of View Campaign Open entities by campaign_id.
GET http://[root url]/view_campaign_open/234

Response Payload
{
    "data":[   
                {
                "Name":"[Name value 1]"                
                ,"Email":"[Email value 1]"                
                ,"Company":"[Company value 1]"  // The company associated with the contact                
                ,"Status":"[Status value 1]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value 1]"  // The phone number for the contact                
                ,"City":"[City value 1]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value 1]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value 1]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value 1]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value 1]"                
                ,"tx_id":"[tx_id value 1]"                
                ,"type":"[type value 1]"                
                ,"email_id":"[email_id value 1]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value 1]"                
                ,"Campaign_Name":"[Campaign_Name value 1]"                
                ,"page_visited":"[page_visited value 1]"                
                ,"device":"[device value 1]"                
                ,"broswer":"[broswer value 1]"                
    
                },
......
                {
                "Name":"[Name value n]"                
                ,"Email":"[Email value n]"                
                ,"Company":"[Company value n]"  // The company associated with the contact                
                ,"Status":"[Status value n]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value n]"  // The phone number for the contact                
                ,"City":"[City value n]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value n]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value n]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value n]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value n]"                
                ,"tx_id":"[tx_id value n]"                
                ,"type":"[type value n]"                
                ,"email_id":"[email_id value n]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value n]"                
                ,"Campaign_Name":"[Campaign_Name value n]"                
                ,"page_visited":"[page_visited value n]"                
                ,"device":"[device value n]"                
                ,"broswer":"[broswer value n]"                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • email_id
  • Email
  • TXIDGreaterThan
  • DateAfter
  • TXType
  • PostFixExcluded
For example
GET http://[root url]/view_campaign_open?email_id=A%20filter%20value

view_campaign_open_unique

View Campaign Open Engagements ...

Requesting Data

The ProFundCom API supports requests for view_campaign_open_unique data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of View Campaign Open Engagements entities by campaign_id.
GET http://[root url]/view_campaign_open_unique/234

Response Payload
{
    "data":[   
                {
                "Name":"[Name value 1]"                
                ,"Email":"[Email value 1]"                
                ,"Company":"[Company value 1]"  // The company associated with the contact                
                ,"Status":"[Status value 1]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value 1]"  // The phone number for the contact                
                ,"City":"[City value 1]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value 1]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value 1]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value 1]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value 1]"                
                ,"tx_id":"[tx_id value 1]"                
                ,"type":"[type value 1]"                
                ,"email_id":"[email_id value 1]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value 1]"                
                ,"Campaign_Name":"[Campaign_Name value 1]"                
                ,"page_visited":"[page_visited value 1]"                
                ,"device":"[device value 1]"                
                ,"broswer":"[broswer value 1]"                
                ,"Engagements":"[Engagements value 1]"                
    
                },
......
                {
                "Name":"[Name value n]"                
                ,"Email":"[Email value n]"                
                ,"Company":"[Company value n]"  // The company associated with the contact                
                ,"Status":"[Status value n]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value n]"  // The phone number for the contact                
                ,"City":"[City value n]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value n]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value n]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value n]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value n]"                
                ,"tx_id":"[tx_id value n]"                
                ,"type":"[type value n]"                
                ,"email_id":"[email_id value n]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value n]"                
                ,"Campaign_Name":"[Campaign_Name value n]"                
                ,"page_visited":"[page_visited value n]"                
                ,"device":"[device value n]"                
                ,"broswer":"[broswer value n]"                
                ,"Engagements":"[Engagements value n]"                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • email_id
  • Email
  • TXIDGreaterThan
  • DateAfter
  • TXType
  • PostFixExcluded
For example
GET http://[root url]/view_campaign_open_unique?email_id=A%20filter%20value

view_campaign_print

View Campaign Print Engagements ...

Requesting Data

The ProFundCom API supports requests for view_campaign_print data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of View Campaign Print Engagements entities by campaign_id.
GET http://[root url]/view_campaign_print/234

Response Payload
{
    "data":[   
                {
                "Name":"[Name value 1]"                
                ,"Email":"[Email value 1]"                
                ,"Company":"[Company value 1]"  // The company associated with the contact                
                ,"Status":"[Status value 1]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value 1]"  // The phone number for the contact                
                ,"City":"[City value 1]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value 1]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value 1]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value 1]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value 1]"                
                ,"tx_id":"[tx_id value 1]"                
                ,"type":"[type value 1]"                
                ,"email_id":"[email_id value 1]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value 1]"                
                ,"Campaign_Name":"[Campaign_Name value 1]"                
                ,"page_visited":"[page_visited value 1]"                
                ,"device":"[device value 1]"                
                ,"broswer":"[broswer value 1]"                
    
                },
......
                {
                "Name":"[Name value n]"                
                ,"Email":"[Email value n]"                
                ,"Company":"[Company value n]"  // The company associated with the contact                
                ,"Status":"[Status value n]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value n]"  // The phone number for the contact                
                ,"City":"[City value n]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value n]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value n]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value n]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value n]"                
                ,"tx_id":"[tx_id value n]"                
                ,"type":"[type value n]"                
                ,"email_id":"[email_id value n]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value n]"                
                ,"Campaign_Name":"[Campaign_Name value n]"                
                ,"page_visited":"[page_visited value n]"                
                ,"device":"[device value n]"                
                ,"broswer":"[broswer value n]"                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • email_id
  • Email
  • TXIDGreaterThan
  • DateAfter
  • TXType
  • PostFixExcluded
For example
GET http://[root url]/view_campaign_print?email_id=A%20filter%20value

view_campaign_print_unique

View Campaign Print Engagements ...

Requesting Data

The ProFundCom API supports requests for view_campaign_print_unique data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of View Campaign Print Engagements entities by campaign_id.
GET http://[root url]/view_campaign_print_unique/234

Response Payload
{
    "data":[   
                {
                "Name":"[Name value 1]"                
                ,"Email":"[Email value 1]"                
                ,"Company":"[Company value 1]"  // The company associated with the contact                
                ,"Status":"[Status value 1]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value 1]"  // The phone number for the contact                
                ,"City":"[City value 1]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value 1]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value 1]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value 1]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value 1]"                
                ,"tx_id":"[tx_id value 1]"                
                ,"type":"[type value 1]"                
                ,"email_id":"[email_id value 1]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value 1]"                
                ,"Campaign_Name":"[Campaign_Name value 1]"                
                ,"page_visited":"[page_visited value 1]"                
                ,"device":"[device value 1]"                
                ,"broswer":"[broswer value 1]"                
                ,"Engagements":"[Engagements value 1]"                
    
                },
......
                {
                "Name":"[Name value n]"                
                ,"Email":"[Email value n]"                
                ,"Company":"[Company value n]"  // The company associated with the contact                
                ,"Status":"[Status value n]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value n]"  // The phone number for the contact                
                ,"City":"[City value n]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value n]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value n]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value n]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value n]"                
                ,"tx_id":"[tx_id value n]"                
                ,"type":"[type value n]"                
                ,"email_id":"[email_id value n]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value n]"                
                ,"Campaign_Name":"[Campaign_Name value n]"                
                ,"page_visited":"[page_visited value n]"                
                ,"device":"[device value n]"                
                ,"broswer":"[broswer value n]"                
                ,"Engagements":"[Engagements value n]"                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • email_id
  • Email
  • TXIDGreaterThan
  • DateAfter
  • TXType
  • PostFixExcluded
For example
GET http://[root url]/view_campaign_print_unique?email_id=A%20filter%20value

view_campaign_ratio

View Campaign All Engagements ...

Requesting Data

The ProFundCom API supports requests for view_campaign_ratio data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of View Campaign All Engagements entities by campaign_id.
GET http://[root url]/view_campaign_ratio/234

Response Payload
{
    "data":[   
                {
                "Name":"[Name value 1]"                
                ,"Email":"[Email value 1]"                
                ,"Company":"[Company value 1]"  // The company associated with the contact                
                ,"Status":"[Status value 1]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value 1]"  // The phone number for the contact                
                ,"City":"[City value 1]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value 1]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value 1]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value 1]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value 1]"                
                ,"tx_id":"[tx_id value 1]"                
                ,"type":"[type value 1]"                
                ,"email_id":"[email_id value 1]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value 1]"                
                ,"Campaign_Name":"[Campaign_Name value 1]"                
                ,"page_visited":"[page_visited value 1]"                
                ,"device":"[device value 1]"                
                ,"broswer":"[broswer value 1]"                
    
                },
......
                {
                "Name":"[Name value n]"                
                ,"Email":"[Email value n]"                
                ,"Company":"[Company value n]"  // The company associated with the contact                
                ,"Status":"[Status value n]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value n]"  // The phone number for the contact                
                ,"City":"[City value n]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value n]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value n]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value n]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value n]"                
                ,"tx_id":"[tx_id value n]"                
                ,"type":"[type value n]"                
                ,"email_id":"[email_id value n]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value n]"                
                ,"Campaign_Name":"[Campaign_Name value n]"                
                ,"page_visited":"[page_visited value n]"                
                ,"device":"[device value n]"                
                ,"broswer":"[broswer value n]"                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • email_id
  • Email
  • TXIDGreaterThan
  • DateAfter
  • TXType
  • PostFixExcluded
For example
GET http://[root url]/view_campaign_ratio?email_id=A%20filter%20value

view_campaign_ratio_unique

View Campaign All Engagements ...

Requesting Data

The ProFundCom API supports requests for view_campaign_ratio_unique data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of View Campaign All Engagements entities by campaign_id.
GET http://[root url]/view_campaign_ratio_unique/234

Response Payload
{
    "data":[   
                {
                "Name":"[Name value 1]"                
                ,"Email":"[Email value 1]"                
                ,"Company":"[Company value 1]"  // The company associated with the contact                
                ,"Status":"[Status value 1]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value 1]"  // The phone number for the contact                
                ,"City":"[City value 1]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value 1]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value 1]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value 1]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value 1]"                
                ,"tx_id":"[tx_id value 1]"                
                ,"type":"[type value 1]"                
                ,"email_id":"[email_id value 1]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value 1]"                
                ,"Campaign_Name":"[Campaign_Name value 1]"                
                ,"page_visited":"[page_visited value 1]"                
                ,"device":"[device value 1]"                
                ,"broswer":"[broswer value 1]"                
                ,"Engagements":"[Engagements value 1]"                
    
                },
......
                {
                "Name":"[Name value n]"                
                ,"Email":"[Email value n]"                
                ,"Company":"[Company value n]"  // The company associated with the contact                
                ,"Status":"[Status value n]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value n]"  // The phone number for the contact                
                ,"City":"[City value n]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value n]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value n]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value n]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value n]"                
                ,"tx_id":"[tx_id value n]"                
                ,"type":"[type value n]"                
                ,"email_id":"[email_id value n]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value n]"                
                ,"Campaign_Name":"[Campaign_Name value n]"                
                ,"page_visited":"[page_visited value n]"                
                ,"device":"[device value n]"                
                ,"broswer":"[broswer value n]"                
                ,"Engagements":"[Engagements value n]"                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • email_id
  • Email
  • TXIDGreaterThan
  • DateAfter
  • TXType
  • PostFixExcluded
For example
GET http://[root url]/view_campaign_ratio_unique?email_id=A%20filter%20value

view_campaign_read

View Campaign Read Engagements ...

Requesting Data

The ProFundCom API supports requests for view_campaign_read data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of View Campaign Read Engagements entities by campaign_id.
GET http://[root url]/view_campaign_read/234

Response Payload
{
    "data":[   
                {
                "Name":"[Name value 1]"                
                ,"Email":"[Email value 1]"                
                ,"Company":"[Company value 1]"  // The company associated with the contact                
                ,"Status":"[Status value 1]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value 1]"  // The phone number for the contact                
                ,"City":"[City value 1]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value 1]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value 1]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value 1]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value 1]"                
                ,"tx_id":"[tx_id value 1]"                
                ,"type":"[type value 1]"                
                ,"email_id":"[email_id value 1]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value 1]"                
                ,"Campaign_Name":"[Campaign_Name value 1]"                
                ,"page_visited":"[page_visited value 1]"                
                ,"device":"[device value 1]"                
                ,"broswer":"[broswer value 1]"                
    
                },
......
                {
                "Name":"[Name value n]"                
                ,"Email":"[Email value n]"                
                ,"Company":"[Company value n]"  // The company associated with the contact                
                ,"Status":"[Status value n]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value n]"  // The phone number for the contact                
                ,"City":"[City value n]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value n]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value n]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value n]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value n]"                
                ,"tx_id":"[tx_id value n]"                
                ,"type":"[type value n]"                
                ,"email_id":"[email_id value n]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value n]"                
                ,"Campaign_Name":"[Campaign_Name value n]"                
                ,"page_visited":"[page_visited value n]"                
                ,"device":"[device value n]"                
                ,"broswer":"[broswer value n]"                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • email_id
  • Email
  • TXIDGreaterThan
  • DateAfter
  • TXType
  • PostFixExcluded
For example
GET http://[root url]/view_campaign_read?email_id=A%20filter%20value

view_campaign_read_unique

View Campaign Read Engagements ...

Requesting Data

The ProFundCom API supports requests for view_campaign_read_unique data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of View Campaign Read Engagements entities by campaign_id.
GET http://[root url]/view_campaign_read_unique/234

Response Payload
{
    "data":[   
                {
                "Name":"[Name value 1]"                
                ,"Email":"[Email value 1]"                
                ,"Company":"[Company value 1]"  // The company associated with the contact                
                ,"Status":"[Status value 1]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value 1]"  // The phone number for the contact                
                ,"City":"[City value 1]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value 1]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value 1]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value 1]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value 1]"                
                ,"tx_id":"[tx_id value 1]"                
                ,"type":"[type value 1]"                
                ,"email_id":"[email_id value 1]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value 1]"                
                ,"Campaign_Name":"[Campaign_Name value 1]"                
                ,"page_visited":"[page_visited value 1]"                
                ,"device":"[device value 1]"                
                ,"broswer":"[broswer value 1]"                
                ,"Engagements":"[Engagements value 1]"                
    
                },
......
                {
                "Name":"[Name value n]"                
                ,"Email":"[Email value n]"                
                ,"Company":"[Company value n]"  // The company associated with the contact                
                ,"Status":"[Status value n]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value n]"  // The phone number for the contact                
                ,"City":"[City value n]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value n]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value n]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value n]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value n]"                
                ,"tx_id":"[tx_id value n]"                
                ,"type":"[type value n]"                
                ,"email_id":"[email_id value n]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value n]"                
                ,"Campaign_Name":"[Campaign_Name value n]"                
                ,"page_visited":"[page_visited value n]"                
                ,"device":"[device value n]"                
                ,"broswer":"[broswer value n]"                
                ,"Engagements":"[Engagements value n]"                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • email_id
  • Email
  • TXIDGreaterThan
  • DateAfter
  • TXType
  • PostFixExcluded
For example
GET http://[root url]/view_campaign_read_unique?email_id=A%20filter%20value

view_campaign_respond

View Campaign Respond ...

Requesting Data

The ProFundCom API supports requests for view_campaign_respond data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of View Campaign Respond entities .
GET http://[root url]/view_campaign_respond
Response Payload
{
    "data":[   
                {
                "Name":"[Name value 1]"                
                ,"Email":"[Email value 1]"                
                ,"Company":"[Company value 1]"                
                ,"Status":"[Status value 1]"                
                ,"Phone":"[Phone value 1]"                
                ,"City":"[City value 1]"                
                ,"Country":"[Country value 1]"                
                ,"Account_Manager":"[Account_Manager value 1]"                
                ,"Date_Read":"[Date_Read value 1]"                
                ,"Document_Read_Name":"[Document_Read_Name value 1]"                
                ,"Document_Read":"[Document_Read value 1]"                
                ,"campaign_id":"[campaign_id value 1]"                
                ,"tx_id":"[tx_id value 1]"                
                ,"ISP":"[ISP value 1]"                
                ,"Organisation":"[Organisation value 1]"                
    
                },
......
                {
                "Name":"[Name value n]"                
                ,"Email":"[Email value n]"                
                ,"Company":"[Company value n]"                
                ,"Status":"[Status value n]"                
                ,"Phone":"[Phone value n]"                
                ,"City":"[City value n]"                
                ,"Country":"[Country value n]"                
                ,"Account_Manager":"[Account_Manager value n]"                
                ,"Date_Read":"[Date_Read value n]"                
                ,"Document_Read_Name":"[Document_Read_Name value n]"                
                ,"Document_Read":"[Document_Read value n]"                
                ,"campaign_id":"[campaign_id value n]"                
                ,"tx_id":"[tx_id value n]"                
                ,"ISP":"[ISP value n]"                
                ,"Organisation":"[Organisation value n]"                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • email_id
  • Email
  • TXIDGreaterThan
  • DateAfter
For example
GET http://[root url]/view_campaign_respond?email_id=A%20filter%20value

Requesting an Individual Entity by ID

The request below returns the collection of view_campaign_respond entity identified by campaign_id.
GET http://[root url]/view_campaign_respond/234
Response Payload
{
    "data":[   
                {
                "Name":"[Name value]"                
                ,"Email":"[Email value]"                
                ,"Company":"[Company value]"                
                ,"Status":"[Status value]"                
                ,"Phone":"[Phone value]"                
                ,"City":"[City value]"                
                ,"Country":"[Country value]"                
                ,"Account_Manager":"[Account_Manager value]"                
                ,"Date_Read":"[Date_Read value]"                
                ,"Document_Read_Name":"[Document_Read_Name value]"                
                ,"Document_Read":"[Document_Read value]"                
                ,"campaign_id":"[campaign_id value]"                
                ,"tx_id":"[tx_id value]"                
                ,"ISP":"[ISP value]"                
                ,"Organisation":"[Organisation value]"                
    
                }
    ],
    "total":1
}

view_campaign_respond_unique

View Campaign Respond Engagements ...

Requesting Data

The ProFundCom API supports requests for view_campaign_respond_unique data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of View Campaign Respond Engagements entities .
GET http://[root url]/view_campaign_respond_unique
Response Payload
{
    "data":[   
                {
                "Name":"[Name value 1]"                
                ,"Email":"[Email value 1]"                
                ,"Company":"[Company value 1]"                
                ,"Status":"[Status value 1]"                
                ,"Phone":"[Phone value 1]"                
                ,"City":"[City value 1]"                
                ,"Country":"[Country value 1]"                
                ,"Account_Manager":"[Account_Manager value 1]"                
                ,"Date_Read":"[Date_Read value 1]"                
                ,"Document_Read_Name":"[Document_Read_Name value 1]"                
                ,"Document_Read":"[Document_Read value 1]"                
                ,"campaign_id":"[campaign_id value 1]"                
                ,"tx_id":"[tx_id value 1]"                
                ,"Engagements":"[Engagements value 1]"                
    
                },
......
                {
                "Name":"[Name value n]"                
                ,"Email":"[Email value n]"                
                ,"Company":"[Company value n]"                
                ,"Status":"[Status value n]"                
                ,"Phone":"[Phone value n]"                
                ,"City":"[City value n]"                
                ,"Country":"[Country value n]"                
                ,"Account_Manager":"[Account_Manager value n]"                
                ,"Date_Read":"[Date_Read value n]"                
                ,"Document_Read_Name":"[Document_Read_Name value n]"                
                ,"Document_Read":"[Document_Read value n]"                
                ,"campaign_id":"[campaign_id value n]"                
                ,"tx_id":"[tx_id value n]"                
                ,"Engagements":"[Engagements value n]"                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • email_id
  • Email
  • TXIDGreaterThan
  • DateAfter
For example
GET http://[root url]/view_campaign_respond_unique?email_id=A%20filter%20value

Requesting an Individual Entity by ID

The request below returns the collection of view_campaign_respond_unique entity identified by campaign_id.
GET http://[root url]/view_campaign_respond_unique/234
Response Payload
{
    "data":[   
                {
                "Name":"[Name value]"                
                ,"Email":"[Email value]"                
                ,"Company":"[Company value]"                
                ,"Status":"[Status value]"                
                ,"Phone":"[Phone value]"                
                ,"City":"[City value]"                
                ,"Country":"[Country value]"                
                ,"Account_Manager":"[Account_Manager value]"                
                ,"Date_Read":"[Date_Read value]"                
                ,"Document_Read_Name":"[Document_Read_Name value]"                
                ,"Document_Read":"[Document_Read value]"                
                ,"campaign_id":"[campaign_id value]"                
                ,"tx_id":"[tx_id value]"                
                ,"Engagements":"[Engagements value]"                
    
                }
    ],
    "total":1
}

view_campaign_scanned

View Campaign Scanned Engagements ...

Requesting Data

The ProFundCom API supports requests for view_campaign_scanned data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of View Campaign Scanned Engagements entities by campaign_id.
GET http://[root url]/view_campaign_scanned/234

Response Payload
{
    "data":[   
                {
                "Name":"[Name value 1]"                
                ,"Email":"[Email value 1]"                
                ,"Company":"[Company value 1]"  // The company associated with the contact                
                ,"Status":"[Status value 1]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value 1]"  // The phone number for the contact                
                ,"City":"[City value 1]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value 1]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value 1]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value 1]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value 1]"                
                ,"tx_id":"[tx_id value 1]"                
                ,"type":"[type value 1]"                
                ,"email_id":"[email_id value 1]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value 1]"                
                ,"Campaign_Name":"[Campaign_Name value 1]"                
                ,"page_visited":"[page_visited value 1]"                
                ,"device":"[device value 1]"                
                ,"broswer":"[broswer value 1]"                
    
                },
......
                {
                "Name":"[Name value n]"                
                ,"Email":"[Email value n]"                
                ,"Company":"[Company value n]"  // The company associated with the contact                
                ,"Status":"[Status value n]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value n]"  // The phone number for the contact                
                ,"City":"[City value n]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value n]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value n]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value n]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value n]"                
                ,"tx_id":"[tx_id value n]"                
                ,"type":"[type value n]"                
                ,"email_id":"[email_id value n]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value n]"                
                ,"Campaign_Name":"[Campaign_Name value n]"                
                ,"page_visited":"[page_visited value n]"                
                ,"device":"[device value n]"                
                ,"broswer":"[broswer value n]"                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • email_id
  • Email
  • TXIDGreaterThan
  • DateAfter
  • TXType
  • PostFixExcluded
For example
GET http://[root url]/view_campaign_scanned?email_id=A%20filter%20value

view_campaign_scanned_unique

View Campaign Scanned Engagements ...

Requesting Data

The ProFundCom API supports requests for view_campaign_scanned_unique data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of View Campaign Scanned Engagements entities by campaign_id.
GET http://[root url]/view_campaign_scanned_unique/234

Response Payload
{
    "data":[   
                {
                "Name":"[Name value 1]"                
                ,"Email":"[Email value 1]"                
                ,"Company":"[Company value 1]"  // The company associated with the contact                
                ,"Status":"[Status value 1]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value 1]"  // The phone number for the contact                
                ,"City":"[City value 1]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value 1]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value 1]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value 1]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value 1]"                
                ,"tx_id":"[tx_id value 1]"                
                ,"type":"[type value 1]"                
                ,"email_id":"[email_id value 1]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value 1]"                
                ,"Campaign_Name":"[Campaign_Name value 1]"                
                ,"page_visited":"[page_visited value 1]"                
                ,"device":"[device value 1]"                
                ,"broswer":"[broswer value 1]"                
                ,"Engagements":"[Engagements value 1]"                
    
                },
......
                {
                "Name":"[Name value n]"                
                ,"Email":"[Email value n]"                
                ,"Company":"[Company value n]"  // The company associated with the contact                
                ,"Status":"[Status value n]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value n]"  // The phone number for the contact                
                ,"City":"[City value n]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value n]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value n]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value n]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value n]"                
                ,"tx_id":"[tx_id value n]"                
                ,"type":"[type value n]"                
                ,"email_id":"[email_id value n]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value n]"                
                ,"Campaign_Name":"[Campaign_Name value n]"                
                ,"page_visited":"[page_visited value n]"                
                ,"device":"[device value n]"                
                ,"broswer":"[broswer value n]"                
                ,"Engagements":"[Engagements value n]"                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • email_id
  • Email
  • TXIDGreaterThan
  • DateAfter
  • TXType
  • PostFixExcluded
For example
GET http://[root url]/view_campaign_scanned_unique?email_id=A%20filter%20value

view_website_activity

View Website Engagements ...

Requesting Data

The ProFundCom API supports requests for view_website_activity data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of View Website Engagements entities .
GET http://[root url]/view_website_activity
Response Payload
{
    "data":[   
                {
                "Name":"[Name value 1]"                
                ,"Email":"[Email value 1]"                
                ,"Company":"[Company value 1]"  // The company associated with the contact                
                ,"Status":"[Status value 1]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value 1]"  // The phone number for the contact                
                ,"City":"[City value 1]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value 1]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value 1]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value 1]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value 1]"                
                ,"tx_id":"[tx_id value 1]"                
                ,"type":"[type value 1]"                
                ,"email_id":"[email_id value 1]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value 1]"                
                ,"Campaign_Name":"[Campaign_Name value 1]"                
                ,"page_visited":"[page_visited value 1]"                
                ,"device":"[device value 1]"                
                ,"broswer":"[broswer value 1]"                
    
                },
......
                {
                "Name":"[Name value n]"                
                ,"Email":"[Email value n]"                
                ,"Company":"[Company value n]"  // The company associated with the contact                
                ,"Status":"[Status value n]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value n]"  // The phone number for the contact                
                ,"City":"[City value n]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value n]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value n]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value n]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value n]"                
                ,"tx_id":"[tx_id value n]"                
                ,"type":"[type value n]"                
                ,"email_id":"[email_id value n]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value n]"                
                ,"Campaign_Name":"[Campaign_Name value n]"                
                ,"page_visited":"[page_visited value n]"                
                ,"device":"[device value n]"                
                ,"broswer":"[broswer value n]"                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • email_id
  • Email
  • TXIDGreaterThan
  • DateAfter
  • TXType
  • PostFixExcluded
For example
GET http://[root url]/view_website_activity?email_id=A%20filter%20value

view_website_activity_unique

View Website Engagements ...

Requesting Data

The ProFundCom API supports requests for view_website_activity_unique data via HTTP GET requests.

Requesting Entity Collections

The request below returns the collection of View Website Engagements entities .
GET http://[root url]/view_website_activity_unique
Response Payload
{
    "data":[   
                {
                "Name":"[Name value 1]"                
                ,"Email":"[Email value 1]"                
                ,"Company":"[Company value 1]"  // The company associated with the contact                
                ,"Status":"[Status value 1]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value 1]"  // The phone number for the contact                
                ,"City":"[City value 1]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value 1]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value 1]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value 1]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value 1]"                
                ,"tx_id":"[tx_id value 1]"                
                ,"type":"[type value 1]"                
                ,"email_id":"[email_id value 1]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value 1]"                
                ,"Campaign_Name":"[Campaign_Name value 1]"                
                ,"page_visited":"[page_visited value 1]"                
                ,"device":"[device value 1]"                
                ,"broswer":"[broswer value 1]"                
                ,"Engagements":"[Engagements value 1]"                
    
                },
......
                {
                "Name":"[Name value n]"                
                ,"Email":"[Email value n]"                
                ,"Company":"[Company value n]"  // The company associated with the contact                
                ,"Status":"[Status value n]"  // The status of the contact - the options for status values are defined by the client, not ProFundCom                
                ,"Phone":"[Phone value n]"  // The phone number for the contact                
                ,"City":"[City value n]"  // The city defined for the contact if there is a mapping for contactcity, otherwise the city detected for the engagement                
                ,"Country":"[Country value n]"  // The country defined for the contact if there is a mapping for contact country, otherwise the country detected for the engagement                
                ,"Account_Manager":"[Account_Manager value n]"  // The account manager defined for the contact based on the mapping for account manager                
                ,"Date_Read":"[Date_Read value n]"  // The date and time of the engagement - whatever type                
                ,"campaign_id":"[campaign_id value n]"                
                ,"tx_id":"[tx_id value n]"                
                ,"type":"[type value n]"                
                ,"email_id":"[email_id value n]"                
                ,"Document_Or_Link_Name":"[Document_Or_Link_Name value n]"                
                ,"Campaign_Name":"[Campaign_Name value n]"                
                ,"page_visited":"[page_visited value n]"                
                ,"device":"[device value n]"                
                ,"broswer":"[broswer value n]"                
                ,"Engagements":"[Engagements value n]"                
    
                },
    ],
    "total":123
}
Optional Filters
The following additional filters can be applies by appending a query string:
  • email_id
  • Email
  • TXIDGreaterThan
  • DateAfter
  • TXType
  • PostFixExcluded
For example
GET http://[root url]/view_website_activity_unique?email_id=A%20filter%20value