Introduction

 

This document details how Vuture Vx interacts with Fibre CRM. Vuture Vx makes REST-full web calls to the CRM API. As Fibre is built on Sugar CRM it has several out-of-the-box (standard) methods available to pull and push data. Fibre have extended methods and added new custom endpoints.

 

Field Definitions

 

Vuture Vx integrates with the following Fibre entities:

 

Entities (Modules) 

Leads

Contacts

fi_CampaignPortal

ProspectLists

Accounts

EmailAddresses

 

Linked Fields:

fi_campaignportal_contacts_1

fi_campaignportal_leads_1

 

Contact Object Fields:

id

first_name

last_name

email1

salutation

title

primary_address_street

primary_address_city

primary_address_state

primary_address_postalcode

primary_address_country

phone_work

phone_mobile

phone_home

account_id

account_name

accept_status

opt_out

invalid_email

 

Endpoints:

 

Standard

https://instanceurl/service/v4_1/rest.php?method=method&input_type=JSON&response_type=JSON&rest_data={jsondata}

 

Custom:

https://instanceurl/custom/service/v4_1_custom/rest.php?method=method&input_type=JSON&response_type=JSON&rest_data={jsondata}

 

Example Calls:

 

Standard 

 

https://instanceurl/service/v4_1/rest.php?method=get_entry&input_type=JSON&response_type=JSON&;
rest_data={"session":"ua5aktdou4c5omrbq1mai2shp0",
                                             "module_name":"fi_CampaignPortal",
                                             "id":"27fd6624-f535-caac-8bf5-5b5b16f8fbf7",
                                             "select_fields":[],"link_name_to_fields_array":[
                                                            {"name":"fi_campaignportal_contacts_1", "value":["id","accept_status","first_name","last_name","email1","salutation","email1","title","primary_address_street","primary_address_city","primary_address_state","primary_address_postalcode","primary_address_country","phone_work","phone_mobile","phone_home"]},{"name":"fi_campaignportal_leads_1","value":["id","first_name","last_name","email1","salutation","email1","title","primary_address_street","primary_address_city","primary_address_state","primary_address_postalcode","primary_address_country","phone_work","phone_mobile","phone_home"]}],"track_view":false}

 

 

 

Custom Endpoints:

 

Update status of method "campaign_portal_relation"

 

https://instanceurl/custom/service/v4_1_custom/rest.php?method=campaign_portal_relation&input_type=JSON&response_type=JSON&rest_data={"session":"r5a7qne1aq61hhbriunuul39s5", "args": {"status":"event_status_update","campaign_portal_id":"6bd06cdd-2b91-7b92-e1c2-5c360dc1954b","link_field_name":"fi_campaignportal_contacts_1","related_ids":{"56c8109d-d063-6e4a-54f0-5c090f82a0eb":{"name":"event_status", "value":"Walk-In"}}}}

 

 

View status of method "campaign_portal_relation"

 

https://instanceurl/custom/service/v4_1_custom/rest.php?method=campaign_portal_relation&input_type=JSON&response_type=JSON&rest_data={"session":"r5a7qne1aq61hhbriunuul39s5", "args": {"status":"event_status_view","campaign_portal_id":"6bd06cdd-2b91-7b92-e1c2-5c360dc1954b","link_field_name":"fi_campaignportal_contacts_1","related_ids":["56c8109d-d063-6e4a-54f0-5c090f82a0eb"]}}