id
stringlengths 14
16
| text
stringlengths 33
5.27k
| source
stringlengths 105
270
|
|---|---|---|
76e8363db03c-2 | "list_price":"745.000000",
"cost_usdollar":"528.000000",
"discount_usdollar":"533.333333",
"list_usdollar":"745.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"33.00",
"qty_in_stock":70,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"ProfitMargin",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"Base_rate":"1.000000"
},
{
"id":"c1b60434-c7f2-11e8-8964-7831c1c14620",
"name":"Billie Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c1b3bf58-c7f2-11e8-92e7-7831c1c14620",
"mft_part_num":"Kringle Bell IncK.A. Tower \u0026 Co 694143XYZ987", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_POST/index.html |
76e8363db03c-3 | "vendor_part_num":null,
"date_cost_price":null,
"cost_price":"403.000000",
"discount_price":"927.000000",
"list_price":"927.000000",
"cost_usdollar":"403.000000",
"discount_usdollar":"927.000000",
"list_usdollar":"927.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"16.00",
"qty_in_stock":148,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"IsList",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"Base_rate":"1.000000"
},
{
"id":"c18e0448-c7f2-11e8-86b0-7831c1c14620",
"name":"Arla Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_POST/index.html |
76e8363db03c-4 | "category_id":"c18b8b64-c7f2-11e8-8c1a-7831c1c14620",
"mft_part_num":"24\/7 Couriers 795391XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"398.000000",
"discount_price":"402.020202",
"list_price":"941.000000",
"cost_usdollar":"398.000000",
"discount_usdollar":"402.020202",
"list_usdollar":"941.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"22.00",
"qty_in_stock":145,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"ProfitMargin",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"Base_rate":"1.000000"
},
{
"id":"c181bd32-c7f2-11e8-b4eb-7831c1c14620",
"name":"Allyson Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_POST/index.html |
76e8363db03c-5 | "description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c18112d8-c7f2-11e8-b753-7831c1c14620",
"mft_part_num":"Ink Conglomerate Inc 921535XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"534.000000",
"discount_price":"842.000000",
"list_price":"905.000000",
"cost_usdollar":"534.000000",
"discount_usdollar":"842.000000",
"list_usdollar":"905.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"20.00",
"qty_in_stock":26,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"Fixed",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"base_rate":"1.000000"
}
]
}
Change Log
Version
Change
v10
Added /Opportunities/recent_product POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_POST/index.html |
c3eeba0a5d68-0 | /me/preference/:preference_name POST
Overview
Creates a preference for the current user.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
Â
Â
Â
Response
{
}
Change Log
Version
Change
v10
Added /me/preference/:preference_name POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/mepreferencepreference_name_POST/index.html |
298f8c8f9baf-0 | /KBContents/:record/useful PUT
Overview
Vote for Knowledge Base article.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
<record field>
<record field type>
Returns the fields for the updated record.
Response
{
"active_date": "2014-01-01",
"active_rev": 1,
"approved": false,
"assigned_user_id": "seed_will_id",
"assigned_user_link": {"full_name": "Will Westin", "id": "seed_will_id"},
"assigned_user_name": "Will Westin",
"attachment_list": [],
"cases": {"name": "", "id": ""},
"category_id": "3e844f1c-5ce1-6d6d-496d-5714901e6666",
"category_name": "Database",
"created_by": "1",
"created_by_link": {"full_name": "Administrator", "id": "1"},
"created_by_name": "Administrator",
"date_entered": "2016-04-18T07:43:43+00:00",
"date_modified": "2016-04-18T07:43:43+00:00",
"deleted": false,
"description": "",
"exp_date": "2014-12-31",
"file_mime_type": "",
"following": false,
"id": "87758ab5-75eb-451f-2bd7-571490d29d7a",
"is_external": false, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecorduseful_PUT/index.html |
298f8c8f9baf-1 | "is_external": false,
"kbarticle_id": "8862943c-022e-0385-908e-5714908ac792",
"kbarticle_name": "Resetting the device",
"kbarticles_kbcontents": {"name": "Resetting the device", "id": "8862943c-022e-0385-908e-5714908ac792"},
"kbdocument_body": "When things are not working as expected...",
"kbdocument_id": "87a20b6b-3172-ad19-0ca5-571490bec118",
"kbdocument_name": "Resetting the device",
"kbdocuments_kbcontents": {"name": "Resetting the device", "id": "87a20b6b-3172-ad19-0ca5-571490bec118"},
"kbsapprover_id": "",
"kbsapprover_name": "",
"kbsapprovers_kbcontents": {"full_name": "", "id": ""},
"kbscase_id": "",
"kbscase_name": "",
"language": "en",
"modified_by_name": "Administrator",
"modified_user_id": "1",
"modified_user_link": {"full_name": "Administrator", "id": "1"},
"my_favorite": false,
"name": "Resetting the device",
"notuseful": 1
"related_languages": ["en"],
"revision": 1
"status": "in-review",
"tag": [],
"team_count": "",
"team_count_link": {"team_count": "", "id": "1"}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecorduseful_PUT/index.html |
298f8c8f9baf-2 | "team_count_link": {"team_count": "", "id": "1"},
"team_name": [{"id": 1, "name": "Global", "name_2": "", "primary": true}],
"useful": 0,
"usefulness_user_vote": "-1",
"viewcount": 4
}
Change Log
Version
Change
v10
Added /KBContents/:record/useful PUT endpoint.
v10
Added /KBContents/:record/notuseful PUT endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecorduseful_PUT/index.html |
641a193888c5-0 | /<module> POST
Overview
Create a new record of a specified type.
Request Arguments
Name
Type
Description
Required
<record field>
<record field type>
The name value list of fields to populate.
True
Request
{
"name":"Example Account",
"account_type":"Customer",
"description":"My Example Account",
"meetings": {
{
"add": ["21e3385e-404f-b470-407e-54044e3d8023"],
"create": [
{
"name": "Test Meeting"
}
]
}
}
}
Link fields
It is possible to add record relations to other records and create new related records.
Action
Type
Description
add
List
List of related records ID. See RelateRecordApi
for details.
create
List
List of name to value arrays of related records.
Response Arguments
Name
Type
Description
<record field>
<record field type>
Returns the fields for the newly created record.
Response
{
"id":"e91b1fa7-1bd8-3c71-be96-512e643f9ca4",
"name":"Example Account",
"date_entered":"2013-02-27T19:56:00+00:00",
"date_modified":"2013-02-27T19:56:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_POST/index.html |
641a193888c5-1 | "created_by":"1",
"created_by_name":"Administrator",
"description":"My Example Account",
"img":"",
"deleted":false,
"assigned_user_id":"",
"assigned_user_name":"",
"team_name":[
{
"id":1,
"name":"Global",
"name_2":"",
"primary":true
}
],
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"account_type":"Customer",
"industry":"",
"annual_revenue":"",
"phone_fax":"",
"billing_address_street":"",
"billing_address_street_2":"",
"billing_address_street_3":"",
"billing_address_street_4":"",
"billing_address_city":"",
"billing_address_state":"",
"billing_address_postalcode":"",
"billing_address_country":"",
"rating":"",
"phone_office":"",
"phone_alternate":"",
"website":"",
"ownership":"",
"employees":"",
"ticker_symbol":"",
"shipping_address_street":"",
"shipping_address_street_2":"",
"shipping_address_street_3":"",
"shipping_address_street_4":"",
"shipping_address_city":"",
"shipping_address_state":"",
"shipping_address_postalcode":"",
"shipping_address_country":"",
"email1":"",
"parent_id":"",
"sic_code":"",
"parent_name":"",
"email_opt_out":"",
"invalid_email":"",
"email":[
], | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_POST/index.html |
641a193888c5-2 | "invalid_email":"",
"email":[
],
"campaign_id":"",
"campaign_name":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
}
Change Log
Version
Change
v10 (7.6.0)
Added support for link fields.
v10
Added /<module> POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_POST/index.html |
ea47e638c11b-0 | /<module>/temp/file/:field POST
Overview
Saves an image to a temporary folder.
Request Arguments
Name
Type
Description
Required
format
String
The data format. Currently accepts 'sugar-html-json'.
True
delete_if_fails
Boolean
Indicates whether the API is to mark related record deleted if the file upload fails.
False
oauth_token
String
The oauth_token value.
False - Required if only if delete_if_fails is true.
<image field>
String
The field and file to populate.
Example: {"":"@\/path\/to\/ExampleImage.png"}
True
Request
{
"format":"sugar-html-json",
"delete_if_fails":true,
"oauth_token":"8d240d9d-04ea-571b-35ea-513037ed5857",
"<image field>":"@\/path\/to\/\/ExampleImage.png"
}
Response Arguments
Name
Type
Description
guid
String
The temp ID of the image.
Response
{
"picture":{
"guid":"50a8760d-966f-9d7e-f45c-513037fac8fc"
}
}
Change Log
Version
Change
v10
Added /<module>/temp/file/:field POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefield_POST/index.html |
a52b0cb1c01f-0 | /EmbeddedFiles/:record/file/:field GET
Overview
Retrieves an attached file for a specific field on a record.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
The response from this request is an HTTP response with a forced download. This can be used in rendering images through the API or in offering immediate file downloads.
Response
Cache-Control: no-cache, must-revalidate Connection: keep-alive Content-Encoding: gzip Content-Type: application/octet-stream Date: Mon, 30 Jan 2012 17:00:46 GMT Expires: Mon, 30 Jan 2012 17:00:45 GMT Last-Modified: Thu, 10 Nov 2011 19:01:31 GMT Transfer-Encoding: chunked Vary: Accept-Encoding...
Change Log
Version
Change
v10
Added /<module>/:record/file/:field GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/EmbeddedFilesrecordfilefield_GET/index.html |
6490f5b65809-0 | /pmse_Project/ActivityDefinition/:record GET
Overview
Retrieves the definition data for an activity
Summary
This endpoint will retrieve the JSON encoded definition data for the Process
Definition activity identified by the record input parameter.
Request Arguments
Name
Type
Description
Required
record
String
The value for the act_uid field in the pmse_bpmn_activity record
True
Response Arguments
Name
Type
Description
success
Boolean
The status of the response
<field>
<value>
Field value in the pmse_bpmn_activity record
Response
{
"success":true,
"id":"566f0156-0ce3-75b4-da56-573cb73984aa",
"name":"Action # 1",
"date_entered":"2016-05-18 18:41:29",
"date_modified":"2016-05-18 18:42:00",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":"0",
"pro_id":"9f8c4fcd-8d4c-949d-50b8-573caddf8c0c",
"act_type":"TASK",
"act_duration":"0",
"act_duration_unit":"DAYS",
"act_send_notification":"0",
"act_assignment_method":"balanced",
"act_assign_team":"",
"act_assign_user":"",
"act_value_based_assignment":"",
"act_reassign":"0",
"act_reassign_team":"",
"act_adhoc":"0",
"act_adhoc_behavior":"",
"act_adhoc_team":"",
"act_response_buttons":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_GET/index.html |
6490f5b65809-1 | "act_adhoc_team":"",
"act_response_buttons":"",
"act_last_user_assigned":"",
"act_field_module":"Accounts",
"act_fields":"[{\u0022name\u0022:\u0022Assigned to\u0022,\u0022field\u0022:\u0022assigned_user_id\u0022,\u0022value\u0022:\u0022currentuser\u0022,\u0022type\u0022:\u0022user\u0022,\u0022label\u0022:\u0022Current user\u0022}]",
"act_readonly_fields":
[
{
"name":"phone_alternate",
"label":"Alternate Phone",
"readonly":false
},
{
"name":"annual_revenue",
"label":"Annual Revenue",
"readonly":false
},
{
"name":"billing_address_city",
"label":"Billing City",
"readonly":false
},
{
"name":"billing_address_country",
"label":"Billing Country",
"readonly":false
},
{
"name":"billing_address_postalcode",
"label":"Billing Postal Code",
"readonly":false
},
{
"name":"billing_address_state",
"label":"Billing State",
"readonly":false
},
{
"name":"billing_address_street",
"label":"Billing Street",
"readonly":false
},
{
"name":"created_by",
"label":"Created By",
"readonly":false
},
{
"name":"description",
"label":"Description",
"readonly":false
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_GET/index.html |
6490f5b65809-2 | "label":"Description",
"readonly":false
},
{
"name":"duns_num",
"label":"DUNS",
"readonly":false
},
{
"name":"employees",
"label":"Employees",
"readonly":false
},
{
"name":"facebook",
"label":"Facebook Account",
"readonly":false
},
{
"name":"phone_fax",
"label":"Fax",
"readonly":false
},
{
"name":"googleplus",
"label":"Google Plus ID",
"readonly":false
},
{
"name":"industry",
"label":"Industry",
"readonly":false
},
{
"name":"modified_user_id",
"label":"Modified By",
"readonly":false
},
{
"name":"name",
"label":"Name",
"readonly":false
},
{
"name":"phone_office",
"label":"Office Phone",
"readonly":false
},
{
"name":"ownership",
"label":"Ownership",
"readonly":false
},
{
"name":"rating",
"label":"Rating",
"readonly":false
},
{
"name":"shipping_address_city",
"label":"Shipping City",
"readonly":false
},
{
"name":"shipping_address_country",
"label":"Shipping Country",
"readonly":false
},
{
"name":"shipping_address_postalcode",
"label":"Shipping Postal Code", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_GET/index.html |
6490f5b65809-3 | "name":"shipping_address_postalcode",
"label":"Shipping Postal Code",
"readonly":false
},
{
"name":"shipping_address_state",
"label":"Shipping State",
"readonly":false
},
{
"name":"shipping_address_street",
"label":"Shipping Street",
"readonly":false
},
{
"name":"sic_code",
"label":"SIC Code",
"readonly":false
},
{
"name":"ticker_symbol",
"label":"Ticker Symbol",
"readonly":false
},
{
"name":"twitter",
"label":"Twitter Account",
"readonly":false
},
{
"name":"account_type",
"label":"Type",
"readonly":false
},
{
"name":"website",
"label":"Website",
"readonly":false
}
],
"act_expected_time":
{
"time":"",
"unit":"hour"
},
"act_required_fields":
[
{
"name":"phone_alternate",
"label":"Alternate Phone",
"required":false
},
{
"name":"annual_revenue",
"label":"Annual Revenue",
"required":false
},
{
"name":"billing_address_city",
"label":"Billing City",
"required":false
},
{
"name":"billing_address_country",
"label":"Billing Country",
"required":false
},
{
"name":"billing_address_postalcode", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_GET/index.html |
6490f5b65809-4 | },
{
"name":"billing_address_postalcode",
"label":"Billing Postal Code",
"required":false
},
{
"name":"billing_address_state",
"label":"Billing State",
"required":false
},
{
"name":"billing_address_street",
"label":"Billing Street",
"required":false
},
{
"name":"created_by",
"label":"Created By",
"required":false
},
{
"name":"description",
"label":"Description",
"required":false
},
{
"name":"duns_num",
"label":"DUNS",
"required":false
},
{
"name":"employees",
"label":"Employees",
"required":false
},
{
"name":"facebook",
"label":"Facebook Account",
"required":false
},
{
"name":"phone_fax",
"label":"Fax",
"required":false
},
{
"name":"googleplus",
"label":"Google Plus ID",
"required":false
},
{
"name":"industry",
"label":"Industry",
"required":false
},
{
"name":"modified_user_id",
"label":"Modified By",
"required":false
},
{
"name":"phone_office",
"label":"Office Phone",
"required":false
},
{
"name":"ownership",
"label":"Ownership",
"required":false
},
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_GET/index.html |
6490f5b65809-5 | "label":"Ownership",
"required":false
},
{
"name":"rating",
"label":"Rating",
"required":false
},
{
"name":"shipping_address_city",
"label":"Shipping City",
"required":false
},
{
"name":"shipping_address_country",
"label":"Shipping Country",
"required":false
},
{
"name":"shipping_address_postalcode",
"label":"Shipping Postal Code",
"required":false
},
{
"name":"shipping_address_state",
"label":"Shipping State",
"required":false
},
{
"name":"shipping_address_street",
"label":"Shipping Street",
"required":false
},
{
"name":"sic_code",
"label":"SIC Code",
"required":false
},
{
"name":"ticker_symbol",
"label":"Ticker Symbol",
"required":false
},
{
"name":"twitter",
"label":"Twitter Account",
"required":false
},
{
"name":"account_type",
"label":"Type",
"required":false
},
{
"name":"website",
"label":"Website",
"required":false
}
],
"act_related_modules":[],
"act_service_url":null,
"act_service_params":null,
"act_service_method":null,
"act_update_record_owner":null,
"execution_mode":"DEFAULT",
"assigned_user_id":"",
"au_first_name":null, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_GET/index.html |
6490f5b65809-6 | "assigned_user_id":"",
"au_first_name":null,
"au_last_name":null,
"cbu_first_name":null,
"cbu_last_name":"Administrator",
"mbu_first_name":null,
"mbu_last_name":"Administrator",
"my_favorite":null
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_GET/index.html |
8373b7897e85-0 | /Users/:record/link/:link_name/:remote_id DELETE
Overview
Deletes an existing relationship between two records.
Request Arguments
This endpoint does not accept any arguments.
Response Arguments
Name
Type
Description
record
Array
The record to disassociate from the related record.
related_record
Array
The record that was disassociated.
Response
{
"record":{
"id":"da6a3741-2a81-ba7f-f249-512d0932e94e",
"name":"Slender Broadband Inc - 1000 units",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-26T19:12:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"last_activity_date":"2013-02-28T18:36:00+00:00",
"deleted":false,
"assigned_user_id":"seed_max_id",
"assigned_user_name":"Max Jensen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"opportunity_type":"",
"account_name":"Slender Broadband Inc", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlinklink_nameremote_id_DELETE/index.html |
8373b7897e85-1 | "opportunity_type":"",
"account_name":"Slender Broadband Inc",
"account_id":"181461c6-dc81-1115-1fe0-512d092e8f15",
"campaign_id":"",
"campaign_name":"",
"lead_source":"Campaign",
"amount":"25000",
"base_rate":"1",
"amount_usdollar":"25000",
"currency_id":"-99",
"currency_name":"",
"currency_symbol":"",
"date_closed":"2013-02-27",
"date_closed_timestamp":"1361992480",
"next_step":"",
"sales_stage":"Needs Analysis",
"sales_status":"New",
"probability":"90",
"best_case":"25000",
"worst_case":"25000",
"commit_stage":"include",
"my_favorite":false,
"_acl":{
"fields":{
}
}
},
"related_record":{
"id":"e689173e-c953-1e14-c215-512d0927e7a2",
"name":"Gus Dales",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-26T19:12:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"deleted":false,
"assigned_user_id":"seed_sally_id", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlinklink_nameremote_id_DELETE/index.html |
8373b7897e85-2 | "deleted":false,
"assigned_user_id":"seed_sally_id",
"assigned_user_name":"Sally Bronsen",
"team_name":[
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Gus",
"last_name":"Dales",
"full_name":"Gus Dales",
"title":"Director Operations",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(661) 120-2292",
"email":[
{
"email_address":"[email protected]",
"opt_out":"1",
"invalid_email":"0",
"primary_address":"0"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
}
],
"phone_mobile":"(294) 447-9707",
"phone_work":"(036) 840-3216",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"primary_address_street":"48920 San Carlos Ave",
"primary_address_street_2":"",
"primary_address_street_3":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlinklink_nameremote_id_DELETE/index.html |
8373b7897e85-3 | "primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Persistance",
"primary_address_state":"CA",
"primary_address_postalcode":"54556",
"primary_address_country":"USA",
"alt_address_street":"",
"alt_address_street_2":"",
"alt_address_street_3":"",
"alt_address_city":"",
"alt_address_state":"",
"alt_address_postalcode":"",
"alt_address_country":"",
"assistant":"",
"assistant_phone":"",
"picture":"",
"email_and_name1":"",
"lead_source":"Support Portal User Registration",
"account_name":"Arts & Crafts Inc",
"account_id":"d43243c6-9b8e-2973-aee2-512d09bc34b4",
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"GusDales145",
"portal_active":true,
"portal_password":"$1$JxYr6tmM$b.O6.KF42jP46RadSwz0N0",
"portal_password1":"",
"portal_app":"",
"preferred_language":"en_us",
"campaign_id":"",
"campaign_name":"",
"c_accept_status_fields":"",
"m_accept_status_fields":"",
"accept_status_id":"",
"accept_status_name":"",
"sync_contact":"",
"my_favorite":false,
"_acl":{
"fields":{
} | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlinklink_nameremote_id_DELETE/index.html |
8373b7897e85-4 | "_acl":{
"fields":{
}
}
}
}
Change Log
Version
Change
v10
Added /<module>/:record/link/:link_name/:remote_id DELETE endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlinklink_nameremote_id_DELETE/index.html |
420cab7e608b-0 | /OutboundEmail/:record PUT
Overview
Update an OutboundEmail configuration.
Summary
Each configuration that is saved is validated first by attempting to connect to the server.
Request Arguments
Name
Type
Description
Required
name
String
The display name of the configuration.
False
mail_sendtype
String
Only SMTP is supported. It is recommended that you do not change this from smtp.
False
mail_smtptype
String
The email provider through which emails are sent. This is merely a convenience which allows for
prepopulating data in the UI. Possible values are: google, exchange, outlook, other.
False
mail_smtpserver
String
The address of the SMTP server.
False
mail_smtpport
Integer
The port on which to connect to the SMTP server.
False
mail_smtpuser
String
The username for authenticating with the SMTP server. It is only required if mail_smtpauth_req is
true.
False
mail_smtppass
String
The password for authenticating with the SMTP server. It is only required if
mail_smtpauth_req is true.
False
mail_smtpauth_req
Boolean
Indicates whether or not the SMTP server requires authentication.
False
mail_smtpssl
String
The encryption protocol used for connecting to the SMTP server. "0" represents no encryption. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/OutboundEmailrecord_PUT/index.html |
420cab7e608b-1 | The encryption protocol used for connecting to the SMTP server. "0" represents no encryption.
"1" represents SSL. "2" represents TLS.
False
Request
{
"mail_smtpport": 587,
"mail_smtpssl": "2"
}
Response Arguments
Name
Type
Description
name
String
The display name of the configuration.
type
String
Possible values are: user, system, system-override. Only the administrator may update the system
configuration. This field may never change.
user_id
String
The current user's ID. The current user may only update configurations that he or she owns.
mail_sendtype
String
Only SMTP is supported, smtp will always be returned.
mail_smtptype
String
The email provider through which emails are sent. Possible values are: google, exchange, outlook, other.
mail_smtpserver
String
The address of the SMTP server.
mail_smtpport
Integer
The port on which to connect to the SMTP server.
mail_smtpuser
String
The username for authenticating with the SMTP server.
mail_smtppass
Boolean
Indicates whether or not a password exists. true is returned for this field when a password does
exist. This field is not included in the response when a password does not exist.
mail_smtpauth_req
Boolean | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/OutboundEmailrecord_PUT/index.html |
420cab7e608b-2 | mail_smtpauth_req
Boolean
Indicates whether or not the SMTP server requires authentication.
mail_smtpssl
String
The encryption protocol used for connecting to the SMTP server.
Response
{
"id": "e04ce998-960e-11e6-8628-3c15c2d582c6",
"name": "My Exchange Account",
"type": "user",
"user_id": "e91b1fa7-1bd8-3c71-be96-512e643f9ca4",
"mail_sendtype": "smtp",
"mail_smtptype": "exchange",
"mail_smtpserver": "smtp.example.com",
"mail_smtpport": 587,
"mail_smtpuser": "[email protected]",
"mail_smtppass": true,
"mail_smtpauth_req": true,
"mail_smtpssl": "2",
"deleted": false,
"my_favorite": false,
"_acl": {
"fields": {}
},
"_module": "OutboundEmail"
}
Change Log
Version
Change
v10
Added /OutboundEmail/:record PUT endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/OutboundEmailrecord_PUT/index.html |
73bd53b61120-0 | /me/password POST
Overview
Create a new record of a specified type.
Summary
This endpoint allows for verification of the user's password. If client type is support_portal, it will update the corrending Contact. Otherwise, it will update User
Request Arguments
Name
Type
Description
Required
password_to_verify
String
The password to verify
True
Request
{
"password_to_verify":"mycurrentpassword"
}
Response Arguments
Name
Type
Description
valid
Boolean
Returns the success of the password verification.
Response
{
"valid":true
}
Change Log
Version
Change
v10
Added /me/password POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/mepassword_POST/index.html |
3823c6e5a01d-0 | /login/content GET
Overview
Returns information to facilitate receiving marketing content from SugarCRM.
Request Arguments
Name
Type
Description
Required
selected_language
String
Code for the desired marketing content language. (Eg. "en_us", "fr_FR").
Providing a certain language code does not guarantee that content returned will be in the provided language.
If an invalid language is specified, will assume "en_us".
False. Defaults to "en_us"
Response Arguments
Name
Type
Description
content_url
String
URL suitable for embedding in an iFrame that links to new marketing material from SugarCRM.
Will always be provided, but may be an empty string if there is no suitable content available.
Response
{
"content_url": "https://marketing.sugarcrm.com/exciting-new-content"
}
Change Log
Version
Change
v11_2
Added /login/content GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/logincontent_GET/index.html |
ae66d51e1a8b-0 | /KBContents/:record/link POST
Overview
Creates relationships to a pre-existing record.
Request Arguments
Name
Type
Description
Required
<relationship link>
<string>
Link between targeted and related records.
True
<record ID>
<string>
The name value list of related records. Each item of the list may be either string equal to related item ID,
or map containing record ID ("id" key is required in this case)
and addition relationship properties.
True
Request
{
link_name: "accounts"
ids: [
"da6a3741-2a81-ba7f-f249-512d0932e94e",
{
"id": "e689173e-c953-1e14-c215-512d0927e7a2",
"role": "owner"
}
]
}
Response Arguments
Name
Type
Description
record
Array
The record linked to related records.
related_records
Array
Records that were associated.
Response
"record": {
"id": "da6a3741-2a81-ba7f-f249-512d0932e94e",
"name": "Slender Broadband Inc - 1000 units",
"date_entered": "2013-02-26T19:12:00+00:00",
"date_modified": "2013-02-26T19:12:00+00:00",
"modified_user_id": "1",
"modified_by_name": "Administrator", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordlink_POST/index.html |
ae66d51e1a8b-1 | "modified_user_id": "1",
"modified_by_name": "Administrator",
"created_by": "1",
"created_by_name": "Administrator",
"description": "",
"img": "",
"last_activity_date": "2013-02-28T18:21:00+00:00",
"deleted": false,
"assigned_user_id": "seed_max_id",
"assigned_user_name": "Max Jensen",
"team_name": [
{
"id": "East",
"name": "East",
"name_2": "",
"primary": false
},
{
"id": "West",
"name": "West",
"name_2": "",
"primary": true
}
],
"opportunity_type": "",
"account_name": "Slender Broadband Inc",
"account_id": "181461c6-dc81-1115-1fe0-512d092e8f15",
"campaign_id": "",
"campaign_name": "",
"lead_source": "Campaign",
"amount": "25000",
"base_rate": "1",
"amount_usdollar": "25000",
"currency_id": "-99",
"currency_name": "",
"currency_symbol": "",
"date_closed": "2013-02-27",
"date_closed_timestamp": "1361992480",
"next_step": "",
"sales_stage": "Needs Analysis",
"sales_status": "New",
"probability": "90",
"best_case": "25000",
"worst_case": "25000", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordlink_POST/index.html |
ae66d51e1a8b-2 | "worst_case": "25000",
"commit_stage": "include",
"my_favorite": false,
"_acl": {
"fields": {
}
}
},
"related_records": [
{
"id": "e689173e-c953-1e14-c215-512d0927e7a2",
"name": "Gus Dales",
"date_entered": "2013-02-26T19:12:00+00:00",
"date_modified": "2013-02-26T19:12:00+00:00",
"modified_user_id": "1",
"modified_by_name": "Administrator",
"created_by": "1",
"created_by_name": "Administrator",
"description": "",
"img": "",
"deleted": false,
"assigned_user_id": "seed_sally_id",
"assigned_user_name": "Sally Bronsen",
"team_name": [
{
"id": "West",
"name": "West",
"name_2": "",
"primary": true
}
],
"salutation": "",
"first_name": "Gus",
"last_name": "Dales",
"full_name": "Gus Dales",
"title": "Director Operations",
"linkedin": "",
"facebook": "",
"twitter": "",
"googleplus": "",
"department": "",
"do_not_call": false,
"phone_home": "(661) 120-2292",
"email": [
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordlink_POST/index.html |
ae66d51e1a8b-3 | "email": [
{
"email_address": "[email protected]",
"opt_out": "1",
"invalid_email": "0",
"primary_address": "0"
},
{
"email_address": "[email protected]",
"opt_out": "0",
"invalid_email": "0",
"primary_address": "1"
}
],
"phone_mobile": "(294) 447-9707",
"phone_work": "(036) 840-3216",
"phone_other": "",
"phone_fax": "",
"email1": "[email protected]",
"email2": "[email protected]",
"invalid_email": false,
"email_opt_out": false,
"primary_address_street": "48920 San Carlos Ave",
"primary_address_street_2": "",
"primary_address_street_3": "",
"primary_address_city": "Persistance",
"primary_address_state": "CA",
"primary_address_postalcode": "54556",
"primary_address_country": "USA",
"alt_address_street": "",
"alt_address_street_2": "",
"alt_address_street_3": "",
"alt_address_city": "",
"alt_address_state": "",
"alt_address_postalcode": "",
"alt_address_country": "",
"assistant": "",
"assistant_phone": "",
"picture": "",
"email_and_name1": "",
"lead_source": "Support Portal User Registration",
"account_name": "Arts & Crafts Inc", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordlink_POST/index.html |
ae66d51e1a8b-4 | "account_name": "Arts & Crafts Inc",
"account_id": "d43243c6-9b8e-2973-aee2-512d09bc34b4",
"opportunity_role_fields": "",
"opportunity_role_id": "",
"opportunity_role": "Technical Advisor",
"reports_to_id": "",
"report_to_name": "",
"portal_name": "GusDales145",
"portal_active": true,
"portal_password": "$1$JxYr6tmM$b.O6.KF42jP46RadSwz0N0",
"portal_password1": "",
"portal_app": "",
"preferred_language": "en_us",
"campaign_id": "",
"campaign_name": "",
"c_accept_status_fields": "",
"m_accept_status_fields": "",
"accept_status_id": "",
"accept_status_name": "",
"sync_contact": "",
"my_favorite": false,
"_acl": {
"fields": {
}
}
},
{
"id": "da6a3741-2a81-ba7f-f249-512d0932e94e",
"name": "Slender Broadband Inc - 1000 units",
"date_entered": "2013-02-26T19:12:00+00:00",
"date_modified": "2013-02-26T19:12:00+00:00",
"modified_user_id": "1",
"modified_by_name": "Administrator",
"created_by": "1",
"created_by_name": "Administrator",
"description": "", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordlink_POST/index.html |
ae66d51e1a8b-5 | "created_by_name": "Administrator",
"description": "",
"img": "",
"last_activity_date": "2013-02-28T18:36:00+00:00",
"deleted": false,
"assigned_user_id": "seed_max_id",
"assigned_user_name": "Max Jensen",
"team_name": [
{
"id": "East",
"name": "East",
"name_2": "",
"primary": false
},
{
"id": "West",
"name": "West",
"name_2": "",
"primary": true
}
],
"opportunity_type": "",
"account_name": "Slender Broadband Inc",
"account_id": "181461c6-dc81-1115-1fe0-512d092e8f15",
"campaign_id": "",
"campaign_name": "",
"lead_source": "Campaign",
"amount": "25000",
"base_rate": "1",
"amount_usdollar": "25000",
"currency_id": "-99",
"currency_name": "",
"currency_symbol": "",
"date_closed": "2013-02-27",
"date_closed_timestamp": "1361992480",
"next_step": "",
"sales_stage": "Needs Analysis",
"sales_status": "New",
"probability": "90",
"best_case": "25000",
"worst_case": "25000",
"commit_stage": "include",
"my_favorite": false,
"_acl": {
"fields": {
} | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordlink_POST/index.html |
ae66d51e1a8b-6 | "_acl": {
"fields": {
}
}
}
]
}
Change Log
Version
Change
v10 (7.6.0)
Added support for additional relationship values.
v10 (7.1.5)
Added /<module>/:record/link POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordlink_POST/index.html |
dbdf986cff6a-0 | /Leads POST
Create Lead with optional post-save actions
Summary:
This endpoint is used to create a Lead with the optional post-save actions for Convert Target/Prospect and
Create Lead from Email operations.
Query Parameters:
Param
Description
Optional
prospect_id
Pass a prospect id if Lead is being created as part of a Convert Target/Prospect process
Optional
inbound_email_id
Pass an inbound email id if Lead is being created from an Email
Optional
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Leads_POST/index.html |
00f0b9e0a1b0-0 | /ForecastWorksheets/:timeperiod_id/:user_id GET
Returns a collection of ForecastWorksheet models
Summary:
This end point is used to return the Worksheets for a user at a given timeperiod. If no timeperiod is provide it
will use the default timeperiod, likewise if no user is provided, it will default to the logged in user.
Also this end points use the visibility requirements set forth by the application, that if the records being requested
belong to you, you will get the draft version, If the worksheet is not yours, you will only see the committed version.
Url Parameters:
Param
Description
Optional
timeperiod_id
Show for a specific time period, defaults to the current time period if one is not passed
Optional
user_id
Show for a specific user, defaults to current user if not defined
Optional
Query Parameters:
Param
Description
Optional
type
Which type to return, currently the ones that are supported are, opportunity and product
Optional
Possible Errors
Error
Description
412 - Invalid Parameter
When the passed in timeperiod and/or user can not be found
403 - Not Authorized
If you are not a manager, but you are tyring to view another sales rep forecast worksheet, you will receive a 403 Not Authorized Error
Url Example:
/rest/v10/ForecastWorksheets/:timeperiod_id/:user_id
Output Example:
{ "next_offset": -1,
"records": [
{
"id": "ad3908c7-83a3-f360-c223-51117844c208",
"name": "Grow-Fast Inc - 1000 units",
"date_entered": "2013-02-05T21:22:00+00:00", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetstimeperiod_iduser_id_GET/index.html |
00f0b9e0a1b0-1 | "date_modified": "2013-02-05T21:22:00+00:00",
"modified_user_id": "1",
"modified_by_name": "Administrator",
"created_by": "1",
"created_by_name": "Administrator",
"description": "",
"img": "",
"deleted": "0",
"assigned_user_id": "seed_jim_id",
"assigned_user_name": "Jim Brennan",
"team_name": [
{
"id": "East",
"name": "East",
"name_2": "",
"primary": true
}
],
"parent_id": "50b90565-e748-ed77-d9d7-511178f5acae",
"parent_type": "Opportunities",
"account_name": "",
"account_id": "",
"likely_case": "75000",
"best_case": "75000",
"worst_case": "75000",
"base_rate": "1",
"currency_id": "-99",
"currency_name": "",
"currency_symbol": "",
"date_closed": "2013-02-10",
"date_closed_timestamp": "1360531443",
"sales_stage": "Perception Analysis",
"probability": "70",
"commit_stage": "include",
"draft": "1",
"my_favorite": false,
"_acl": {
"fields": {}
}
}]
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetstimeperiod_iduser_id_GET/index.html |
287a31eb0d98-0 | /<module>/:record/path GET
Overview
Retrieves all parents of selected record.
Request Arguments
Name
Type
Description
Required
module
String
The name of sugar module that contains a nested set data and implements the NestedSetInterface.
True
:record
String
The ID of record
True
Response Arguments
This endpoint does not return any response arguments.
Response
[{
"id": "045c03b9-327b-11e4-818b-5404a67f3363",
"name": "Audit",
"date_entered": null,
"date_modified": null,
"modified_user_id": null,
"created_by": null,
"description": null,
"deleted": "0",
"source_id": null,
"source_type": null,
"source_meta": null,
"root": "935d3e07-327a-11e4-818b-5404a67f3363",
"lft": "10",
"rgt": "19",
"level": "1"
}, {
"id": "045c1de6-327b-11e4-818b-5404a67f3363",
"name": "Financial",
"date_entered": null,
"date_modified": null,
"modified_user_id": null,
"created_by": null,
"description": null,
"deleted": "0",
"source_id": null,
"source_type": null,
"source_meta": null, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordpath_GET/index.html |
287a31eb0d98-1 | "source_type": null,
"source_meta": null,
"root": "935d3e07-327a-11e4-818b-5404a67f3363",
"lft": "11",
"rgt": "14",
"level": "2"
}]
Change Log
Version
Change
v10
Added /<module>/:record/path GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordpath_GET/index.html |
f0be1242f420-0 | /<module>/:record/link/:link_name/add_record_list/:remote_id POST
Overview
Creates relationships to pre-existing record from a record list.
URL Arguments
Name
Type
Description
Required
<record ID>
<string>
Target record ID.
True.
<report ID>
<string>
Report ID for Saved Report.
True.
<relationship link>
<string>
Link between targeted and related records.
True.
Request
Response Arguments
Name
Type
Description
record
Array
The record linked to related records.
related_records
Array
Record IDs that were associated.
Response
"record": {
"id": "da6a3741-2a81-ba7f-f249-512d0932e94e",
"name": "Slender Broadband Inc - 1000 units",
"date_entered": "2013-02-26T19:12:00+00:00",
"date_modified": "2013-02-26T19:12:00+00:00",
"modified_user_id": "1",
"modified_by_name": "Administrator",
"created_by": "1",
"created_by_name": "Administrator",
"description": "",
"img": "",
"last_activity_date": "2013-02-28T18:21:00+00:00",
"deleted": false,
"assigned_user_id": "seed_max_id",
"assigned_user_name": "Max Jensen", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameadd_record_listremote_id_POST/index.html |
f0be1242f420-1 | "assigned_user_name": "Max Jensen",
"team_name": [
{
"id": "East",
"name": "East",
"name_2": "",
"primary": false
},
{
"id": "West",
"name": "West",
"name_2": "",
"primary": true
}
],
"opportunity_type": "",
"account_name": "Slender Broadband Inc",
"account_id": "181461c6-dc81-1115-1fe0-512d092e8f15",
"campaign_id": "",
"campaign_name": "",
"lead_source": "Campaign",
"amount": "25000",
"base_rate": "1",
"amount_usdollar": "25000",
"currency_id": "-99",
"currency_name": "",
"currency_symbol": "",
"date_closed": "2013-02-27",
"date_closed_timestamp": "1361992480",
"next_step": "",
"sales_stage": "Needs Analysis",
"sales_status": "New",
"probability": "90",
"best_case": "25000",
"worst_case": "25000",
"commit_stage": "include",
"my_favorite": false,
"_acl": {
"fields": {
}
}
},
"related_records": [
success: [
"e689173e-c953-1e14-c215-512d0927e7a2", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameadd_record_listremote_id_POST/index.html |
f0be1242f420-2 | "da6a3741-2a81-ba7f-f249-512d0932e94e",
"181461c6-dc81-1115-1fe0-512d092e8f15"
],
error: []
]
}
Change Log
Version
Change
v10 (7.2.0)
Added /<module>/:record/link/:link_name/add_record_list/:remote_id POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameadd_record_listremote_id_POST/index.html |
1f75a3762018-0 | /metadata/<module>/:segment GET
Overview
[ADMIN] Gets the desired segment for a given module.
Summary
Gets the desired segment for a given module. This is used only for modules that are not visible and thus not in metatdata for the given context. This endpoint is only available to administrators.
Request Arguments
This endpoint does not accept any request arguments.
Response
{
"fields": {
Any fields associated with the module
}
}
Change Log
Version
Change
v11_11
Added /metadata/<module>/:segment GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/metadatamodulesegment_GET/index.html |
95e113bfad08-0 | /ConsoleConfiguration/config POST
Overview
Saves configuration changes in the database.
Request Arguments
This endpoint does not accept any request arguments.
URL Example
/rest/v11_9/ConsoleConfiguration/config
Request Payload Example
{
"is_setup":true,
"enabled_modules":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":[
"Cases"
],
"da438c86-df5e-11e9-9801-3c15c2c53980":[
"Accounts",
"Opportunities"
]
},
"order_by_primary":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":{
"Cases":"follow_up_datetime:asc"
},
"da438c86-df5e-11e9-9801-3c15c2c53980":{
"Accounts":"next_renewal_date:asc",
"Opportunities":"date_closed:asc"
}
},
"order_by_secondary":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":{
"Cases":""
},
"da438c86-df5e-11e9-9801-3c15c2c53980":{
"Accounts":"",
"Opportunities":""
}
},
"filter_def":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html |
95e113bfad08-1 | "Cases":[
{
"status":{
"$not_in":[
"Closed",
"Rejected",
"Duplicate"
]
}
},
{
"$owner":""
}
]
},
"da438c86-df5e-11e9-9801-3c15c2c53980":{
"Accounts":[
{
"$owner":""
}
],
"Opportunities":[
{
"sales_status":{
"$not_in":[
"Closed Won",
"Closed Lost"
]
}
},
{
"$owner":""
}
]
}
},
"defaults":{
"is_setup":0,
"enabled_modules":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":[
"Cases"
],
"da438c86-df5e-11e9-9801-3c15c2c53980":[
"Accounts",
"Opportunities"
]
},
"order_by_primary":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":{
"Cases":"follow_up_datetime:asc"
},
"da438c86-df5e-11e9-9801-3c15c2c53980":{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html |
95e113bfad08-2 | "Accounts":"next_renewal_date:asc",
"Opportunities":"date_closed:asc"
}
},
"order_by_secondary":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":{
"Cases":""
},
"da438c86-df5e-11e9-9801-3c15c2c53980":{
"Accounts":"",
"Opportunities":""
}
},
"filter_def":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":{
"Cases":[
{
"status":{
"$not_in":[
"Closed",
"Rejected",
"Duplicate"
]
}
},
{
"$owner":""
}
]
},
"da438c86-df5e-11e9-9801-3c15c2c53980":{
"Accounts":[
{
"$owner":""
}
],
"Opportunities":[
{
"sales_status":{
"$not_in":[
"Closed Won",
"Closed Lost"
]
}
},
{
"$owner":""
}
]
}
}
},
"labels":{
"Cases":[
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html |
95e113bfad08-3 | },
"labels":{
"Cases":[
{
"label":"LBL_LIST_PRIORITY/LBL_STATUS",
"labelValue":"Priority/Status"
},
{
"label":"LBL_LIST_SUBJECT/LBL_SERVICE_LEVEL",
"labelValue":"Subject/Service Level"
}
]
},
"viewdefs":{
"Cases":{
"base":{
"view":{
"multi-line-list":{
"panels":[
{
"label":"LBL_LABEL_1",
"fields":[
{
"name":"case_number",
"label":"LBL_AGENT_WORKBENCH_NUMBER",
"subfields":[
{
"default":true,
"enabled":true,
"name":"case_number",
"label":"LBL_AGENT_WORKBENCH_NUMBER"
}
]
},
{
"name":"Priority/Status",
"label":"LBL_LIST_PRIORITY/LBL_STATUS",
"subfields":[
{
"default":true,
"enabled":true,
"name":"priority",
"label":"LBL_LIST_PRIORITY",
"type":"enum"
},
{
"default":true,
"enabled":true,
"name":"status",
"label":"LBL_STATUS",
"type":"case-status",
"widget_name":"widget_status"
}
]
},
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html |
95e113bfad08-4 | }
]
},
{
"name":"Subject/Service Level",
"label":"LBL_LIST_SUBJECT/LBL_SERVICE_LEVEL",
"subfields":[
{
"default":true,
"enabled":true,
"name":"name",
"label":"LBL_LIST_SUBJECT",
"link":false
},
{
"default":true,
"enabled":true,
"name":"service_level",
"label":"LBL_SERVICE_LEVEL",
"type":"enum",
"enum_module":"Accounts",
"link":false
}
]
}
]
}
],
"collectionOptions":{
"limit":100,
"params":{
"max_num":100,
"order_by":"follow_up_datetime",
"nulls_last":true
}
},
"filterDef":[
{
"status":{
"$not_in":[
"Closed",
"Rejected",
"Duplicate"
]
},
"$owner":""
}
]
}
}
}
}
}
}
Response Arguments
Response
{
"is_setup":1,
"enabled_modules":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":[
"Cases"
], | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html |
95e113bfad08-5 | "Cases"
],
"da438c86-df5e-11e9-9801-3c15c2c53980":[
"Accounts",
"Opportunities"
]
},
"order_by_primary":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":{
"Cases":"follow_up_datetime:asc"
},
"da438c86-df5e-11e9-9801-3c15c2c53980":{
"Accounts":"next_renewal_date:asc",
"Opportunities":"date_closed:asc"
}
},
"order_by_secondary":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":{
"Cases":""
},
"da438c86-df5e-11e9-9801-3c15c2c53980":{
"Accounts":"",
"Opportunities":""
}
},
"filter_def":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":{
"Cases":[
{
"status":{
"$not_in":[
"Closed",
"Rejected",
"Duplicate"
]
}
},
{
"$owner":""
}
]
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html |
95e113bfad08-6 | "$owner":""
}
]
},
"da438c86-df5e-11e9-9801-3c15c2c53980":{
"Accounts":[
{
"$owner":""
}
],
"Opportunities":[
{
"sales_status":{
"$not_in":[
"Closed Won",
"Closed Lost"
]
}
},
{
"$owner":""
}
]
}
},
"defaults":{
"is_setup":0,
"enabled_modules":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":[
"Cases"
],
"da438c86-df5e-11e9-9801-3c15c2c53980":[
"Accounts",
"Opportunities"
]
},
"order_by_primary":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":{
"Cases":"follow_up_datetime:asc"
},
"da438c86-df5e-11e9-9801-3c15c2c53980":{
"Accounts":"next_renewal_date:asc",
"Opportunities":"date_closed:asc"
}
},
"order_by_secondary":{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html |
95e113bfad08-7 | }
},
"order_by_secondary":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":{
"Cases":""
},
"da438c86-df5e-11e9-9801-3c15c2c53980":{
"Accounts":"",
"Opportunities":""
}
},
"filter_def":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":{
"Cases":[
{
"status":{
"$not_in":[
"Closed",
"Rejected",
"Duplicate"
]
}
},
{
"$owner":""
}
]
},
"da438c86-df5e-11e9-9801-3c15c2c53980":{
"Accounts":[
{
"$owner":""
}
],
"Opportunities":[
{
"sales_status":{
"$not_in":[
"Closed Won",
"Closed Lost"
]
}
},
{
"$owner":""
}
]
}
}
}
}
Response Codes and Error Messages
This API does not return new errors other than the ones that may be returned by its parent API - ConfigModule API. The following error responses are possible: | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html |
95e113bfad08-8 | 403 (SugarAPIExceptionNotAuthorized) : Sent if the user attempts to access a module that they are forbidden to access.
Change Log
Version
Change
v11.9
Added /ConsoleConfiguration/config POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html |
c66f798a2c63-0 | /<module>/:record/link/:link_name/leancount GET
Overview
Lists related filtered records.
Summary
This endpoint will return a set of related records filtered by an expression. The filter can be applied to multiple
fields and have multiple and/or conditions in it. Care will need to be taken to make sure this filter has
appropriate indexes on the server side otherwise the runtime of the endpoint will be very long. Related fields can
be searched by specifying the field name as: "link_name.remote_field", so if you wished to search the Accounts
module by a related member account you would use "members.sic_code".
Request Arguments
Name
Type
Description
Required
filter
String
The filter expression. Filter expressions are explained below.
False
max_num
Integer
A maximum number of records to return. Default is 20.
False
offset
Integer
The number of records to skip over before records are returned. Default is 0.
False
fields
String
Comma delimited list of fields to return. The field date_modified will always be returned. This argument
can be combined with the view argument.
Example: name,account_type,description
False
view
String
Instead of defining the fields argument, the view argument can be used instead. The field list is
constructed at the server side based on the view definition which is requested. This argument can be used
in combination with the fields argument. Common views are "record" and "list".
Example: record
False
order_by
String | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html |
c66f798a2c63-1 | False
order_by
String
How to sort the returned records, in a comma delimited list with the direction appended to the column name
after a colon.
Example: name:DESC,account_type:DESC,date_modified:ASC
False
Filter Expressions
There are four types of filters:
Basic
This will filter the results by checking the field "name" for value "Nelson Inc". This will only find exact matches.
Example
{
"filter":[
{
"name":"Nelson Inc"
}
]
}
Full
This expression allows you to specify what operation you want to use for filtering on the field. In the example you
would match any record where the field "name" starts with the value "Nelson".
Example
{
"filter":[
{
"name":{
"$starts":"Nelson"
}
}
]
}
Below is a list of operation types:
Operation
Description
$equals
Performs an exact match on that field.
$not_equals
Performs an exact match on that field.
$not_equals
Matches on non-matching values.
$starts
Matches on anything that starts with the value.
$ends
Matches anything that ends with the value.
$contains
Matches anything that contains the value
$in
Finds anything where field matches one of the values as specified as an array.
$not_in
Finds anything where field does not matches any of the values as specified as an array. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html |
c66f798a2c63-2 | $is_null
Checks if the field is null. This operation does not need a value specified.
$not_null
Checks if the field is not null. This operation does not need a value specified.
$lt
Matches when the field is less than the value.
$lte
Matches when the field is less than or equal to the value.
$gt
Matches when the field is greater than the value.
$gte
Matches when the field is greater than or equal to the value.
Sub-expressions
This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.
The example expression would match if the field "name" was either "Nelson Inc" or "Nelson LLC". The only currently
accepted sub-expression types are "$and" and "$or".
Example
{
"filter":[
{
"$or":[
{
"name":"Nelson Inc"
},
{
"name":"Nelson LLC"
}
]
}
]
}
Modules
There are two module expressions, they operate on modules instead of fields. The current module can be specified by
either using the module name "_this" or by leaving the module name as a blank string. The example expression would
filter the records in the current module to only your favorites. The only currently accepted module expressions are
"$favorite" and "$owner".
Example
{
"filter":[
{
"$favorite":"_this"
}
]
}
Response Arguments
Name
Type
Description
next_offset | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html |
c66f798a2c63-3 | ]
}
Response Arguments
Name
Type
Description
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more
records.
records
Array
An array of results containing matched records.
Repsonse
{
"next_offset":-1,
"records":[
{
"id":"fa300a0e-0ad1-b322-9601-512d0983c19a",
"name":"Dale Spivey",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-28T05:03:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"deleted":false,
"assigned_user_id":"seed_sally_id",
"assigned_user_name":"Sally Bronsen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":1,
"name":"Global",
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Dale",
"last_name":"Spivey", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html |
c66f798a2c63-4 | "first_name":"Dale",
"last_name":"Spivey",
"full_name":"Dale Spivey",
"title":"VP Operations",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(523) 825-4311",
"email":[
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"0"
}
],
"phone_mobile":"(373) 861-0757",
"phone_work":"(212) 542-9596",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"primary_address_street":"345 Sugar Blvd.",
"primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Denver",
"primary_address_state":"CA",
"primary_address_postalcode":"87261",
"primary_address_country":"USA",
"alt_address_street":"",
"alt_address_street_2":"",
"alt_address_street_3":"",
"alt_address_city":"",
"alt_address_state":"",
"alt_address_postalcode":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html |
c66f798a2c63-5 | "alt_address_state":"",
"alt_address_postalcode":"",
"alt_address_country":"",
"assistant":"",
"assistant_phone":"",
"picture":"",
"email_and_name1":"",
"lead_source":"Campaign",
"account_name":"Smallville Resources Inc",
"account_id":"d5db6292-5c24-eb61-e202-512d09f0134e",
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"DaleSpivey97",
"portal_active":true,
"portal_password":"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\/",
"portal_password1":"",
"portal_app":"",
"preferred_language":"en_us",
"campaign_id":"",
"campaign_name":"",
"c_accept_status_fields":"",
"m_accept_status_fields":"",
"accept_status_id":"",
"accept_status_name":"",
"sync_contact":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
},
{
"id":"95e17367-9b3d-0e26-22dc-512d0961fedf",
"name":"Florence Haddock",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-26T19:12:00+00:00", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html |
c66f798a2c63-6 | "modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"deleted":false,
"assigned_user_id":"seed_sally_id",
"assigned_user_name":"Sally Bronsen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":1,
"name":"Global",
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Florence",
"last_name":"Haddock",
"full_name":"Florence Haddock",
"title":"Director Sales",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(729) 845-3137",
"email":[
{
"email_address":"[email protected]",
"opt_out":"1",
"invalid_email":"0",
"primary_address":"0"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
}
],
"phone_mobile":"(246) 233-1382", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html |
c66f798a2c63-7 | ],
"phone_mobile":"(246) 233-1382",
"phone_work":"(565) 696-6981",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"primary_address_street":"111 Silicon Valley Road",
"primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Denver",
"primary_address_state":"CA",
"primary_address_postalcode":"79900",
"primary_address_country":"USA",
"alt_address_street":"",
"alt_address_street_2":"",
"alt_address_street_3":"",
"alt_address_city":"",
"alt_address_state":"",
"alt_address_postalcode":"",
"alt_address_country":"",
"assistant":"",
"assistant_phone":"",
"picture":"",
"email_and_name1":"",
"lead_source":"Support Portal User Registration",
"account_name":"Smallville Resources Inc",
"account_id":"d5db6292-5c24-eb61-e202-512d09f0134e",
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"FlorenceHaddock169",
"portal_active":true,
"portal_password":"$1$nWFhTbK6$JF9BCGSqL\/NCrbhueX5ia0", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html |
c66f798a2c63-8 | "portal_password1":"",
"portal_app":"",
"preferred_language":"en_us",
"campaign_id":"",
"campaign_name":"",
"c_accept_status_fields":"",
"m_accept_status_fields":"",
"accept_status_id":"",
"accept_status_name":"",
"sync_contact":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
}
]
}
Change Log
Version
Change
v10
Added /<module>/:record/link/:link_name/filter GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html |
f42b6fedbb40-0 | /search GET
Overview
List records in a module. Searching, filtering and ordering can be applied to only fetch the records you are interested in. Additionally the set of returned fields can be restricted to speed up processing and reduce download times.
Request Arguments
Name
Type
Description
Required
q
String
The search text to match records on. This will search through any fields on the module that has unified_search set to true.
False
max_num
Integer
A maximum number of records to return.
False
offset
Integer
The number of records to skip over before records are returned.
False
fields
String
Comma delimited list of fields to return. The field date_modified will always be returned.
Example: name,account_type,description
False
order_by
String
How to sort the returned records, in a comma delimited list with the direction appended to the column name after a colon.
Example: name:DESC,account_type:DESC,date_modified:ASC
False
favorites
Boolean
Only fetch the current users favorited records.
False
my_items
Boolean
Only fetch items assigned to the current user.
False
Response Arguments
Name
Type
Description
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more records.
records
Array
An array of results containing matched records.
Response
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/search_GET/index.html |
f42b6fedbb40-1 | An array of results containing matched records.
Response
{
"next_offset":2,
"records":[
{
"id":"ecbf2a6c-261e-5fca-fbb6-512d093554b8",
"name":"Avery Software Co",
"date_modified":"2013-02-26T19:12:56+00:00",
"description":"",
"my_favorite":false,
"_acl":{
"fields":{
}
},
"_module":"Accounts",
"_search":{
"score":1
}
},
{
"id":"af5f8dae-7169-b497-1d77-512d0937ed81",
"name":"Avery Software Co",
"date_modified":"2013-02-26T19:12:56+00:00",
"description":"",
"my_favorite":false,
"_acl":{
"fields":{
}
},
"_module":"Accounts",
"_search":{
"score":1
}
}
]
}
Change Log
Version
Change
v10
Added /<module> GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/search_GET/index.html |
0bf918834711-0 | /Forecasts/user/:user_id GET
ForecastsApi - user
Summary:
This endpoint is used to return a user's id, user_name, full_name, first_name, last_name, and is_manager param given a user's id.
Query Parameters:
Param
Description
Optional
user_id
Returns user data for this specific user id
Â
Input Example:
{
user_id:seed_sally_id
}
Output Example:
{
first_name: "Sally"
full_name: "Sally Bronsen"
id: "seed_sally_id"
is_manager: false
last_name: "Bronsen"
user_name: "sally"
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsuseruser_id_GET/index.html |
9f4ed768865f-0 | /<module>/append/:target POST
Overview
Append new node to target node as last child.
Request Arguments
Name
Type
Description
Required
module
String
The name of sugar module that contains a nested set data and implements the NestedSetInterface.
True
target
String
The ID of record that will be used as target to append new node
True
Request
{
"name" : "Children Node 1"
}
Response Arguments
This endpoint does not return any response arguments.
Response
This endpoint returns a newly created bean
{
"my_favorite":false,
"following":"",
"id":"59fa8dd7-0f2c-4bfd-364f-54495f77fa3f",
"name":"Default title",
"date_entered":"2014-10-23T23:03:22+03:00",
"date_modified":"2014-10-23T23:03:22+03:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"doc_owner":"",
"description":"",
"deleted":false,
"source_id":"",
"source_type":"",
"source_meta":"",
"root":"be9b0c4a-8b78-1ffa-4f14-54481c2f6269",
"lft":118,
"rgt":119,
"level":1,
"_acl":{"fields":{}},
"_module":"Categories"
}
Change Log | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleappendtarget_POST/index.html |
9f4ed768865f-1 | "_module":"Categories"
}
Change Log
Version
Change
v10
Added /<module>/append/:target POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleappendtarget_POST/index.html |
d9aa0c9907e6-0 | /theme GET
Overview
Fetches the customizable variables of a theme.
Request Arguments
Name
Type
Description
Required
platform
String
The theme platform - /themes/clients/***PLATFORM***/themeName/. Accepted values are 'base' and 'portal'.
False
themeName
String
The theme name - /themes/clients/platform/***THEME NAME***/.
False
Request
http://{site_url}/rest/v10/theme?platform=base&themeName=default
Note: GET endpoint parameters are passed in the form of a query string.
Response Arguments
Name
Type
Description
mixins
Array
An array of name value pairs detailing mixin colors
hex
Array
A array of name value pairs detailing css colors
rgba
Array
An array of name value pairs detailing colors
rel
Array
An array of name value pairs detailing relationships
bg
Array
An array of name value pairs detailing backgroup colors
Response
{
"colors":[
{
"name":"BorderColor",
"value":"#E61718"
},
{
"name":"NavigationBar",
"value":"#000000"
},
{
"name":"PrimaryButton",
"value":"#177EE5"
}
]
}
Change Log
Version
Change
v10
Added /<theme> GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/theme_GET/index.html |
4db84998c376-0 | /Forecasts/:timeperiod_id/progressRep/:user_id GET
Projected Rep Data
Summary:
This endpoint is used to return the json Data not already in client view for the Forecasts rep projected panel.
Query Parameters:
Param
Description
Optional
user_id
Show for a specific user, defaults to current user if not defined
Optional
timeperiod_id
Show for a specific time period, defaults to the current time period if one is not passed
Optional
Input Example:
{
user_id:seed_sally_id
timeperiod_id:36f7085a-5889-ea75-84c8-50f42bd1a5ba
}
Output Example:
{
quota_amount: "80000.000000"
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecaststimeperiod_idprogressRepuser_id_GET/index.html |
c9230651fe2c-0 | /pmse_Inbox/unattendedCases GET
Overview
Retrieves the processes to show on Unattended Process view
Summary
This endpoint gets the list of unattended processes
Request Arguments
Name
Type
Description
Required
module_list
string
Identifier used to determine which field to filter against
true
q
string
Filter applied to a field to determine which processes to return
false
order_by
string
Sort definition to apply to the result
false
Response Arguments
Name
Type
Description
next_offset
integer
Next offset for more results
records
<field>:<value>
List of unattended process attributes
Response
{
"next_offset":"-1",
"records":
[
{
"id":"3922976c-284f-11e6-9f40-6c4008960436",
"assigned_user_id":"1",
"date_modified":"2016-06-01 23:18:59",
"date_entered":"2016-06-01T16:18:59-07:00",
"name":"ABC2",
"cas_id":"2",
"cas_title":"ABC2",
"cas_status":"IN PROGRESS",
"pro_title":"PD1",
"pro_id":"6e172e2c-2842-11e6-a4bb-6c4008960436",
"cas_init_user":"1",
"cas_user_full_name":"Sarah Smith",
"prj_id":"6e025038-2842-11e6-b4f7-6c4008960436",
"prj_user_id_full_name":"Administrator", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxunattendedCases_GET/index.html |
c9230651fe2c-1 | "prj_user_id_full_name":"Administrator",
"cas_sugar_object_id":"38beb03a-284f-11e6-b059-6c4008960436",
"cas_sugar_module":"Accounts",
"assigned_user_name":"Administrator"
}
]
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxunattendedCases_GET/index.html |
d06e66b12697-0 | Security
Security documents for securing Sugars infastructure.
TopicsEndpoints and Entry PointsThis document describes how to disable out of the box REST API endpoints and legacy MVC entry points.Web Server ConfigurationThis document serves as a guideline to harden the web server configuration with regard to running SugarCRM. Note that this is a guideline and certain settings will depend on your specific environment and setup. This guideline focuses on Apache web server as this is SugarCRM's primary supported web server. However, the recommendations in this document apply to all web servers in general.XSS PreventionThis document describes how to prevent cross-site scripting (XSS) attacks in Sugar customizations. XSS attacks occur when malicious entities are able to inject client-side scripts into web pages.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/index.html |
abad7bffe7ab-0 | Endpoints and Entry Points
Overview
This document describes how to disable out of the box REST API endpoints and legacy MVC entry points.
Advisory ID: sugarcrm-sr-2015-001Revision: 1.1Last updated: 2015-10-01
Description
SugarCRM has both legacy entry points and REST API endpoints which are shipped out of the box. Not every customer uses all capabilities of the SugarCRM product. To harden the configuration both entry points can be disabled based on the customer's requirements.
Legacy Entry Points
All stock entry points are defined in include/MVC/Controller/entry_point_registry.php. Using the SugarCRM Extension framework the configuration directives can be overridden in an upgrade safe manner. As an example consider the entrypoint "removeme". To disable this entrypoint use the following procedure.
Create a new php file ./custom/Extension/application/Ext/EntryPointRegistry/disable_removeme.php and add the following content:
<?php
if (isset($entry_point_registry['removeme'])) {
unset($entry_point_registry['removeme']);
}
Execute a quick repair and rebuild as SugarCRM administrator. The entry point is now fully disabled and no longer accessible to respond to any calls. Note that when trying to hit an non-existing (or disabled) entry point, the application will redirect you to the homepage (or login screen if the user has no session).
REST API Endpoints
To disable the HelpAPI which is located at clients/base/api/HelpApi.php use the following procedure.
Create a new php file custom/clients/base/api/CustomHelpApi.php and add the following content:
<?php
require_once 'clients/base/api/HelpApi.php';
class CustomHelpApi extends HelpApi
{
public function getHelp($api, $args)
{
throw new SugarApiExceptionNotFound();
}
} | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/Endpoints_and_Entry_Points/index.html |
abad7bffe7ab-1 | {
throw new SugarApiExceptionNotFound();
}
}
Execute a quick repair and rebuild as SugarCRM administrator. The entry point is now fully disabled. When making a REST API call to /rest/v10/help the followingHTTP 404 Not Found error will be returned:
{
"error": "not_found",
"error_message": "Your requested resource was not found."
}
Publication History
2015-10-01
Adding REST API endpoint example
2015-06-16
Initial publication
A stand-alone copy of this document that omits the distribution URL is an uncontrolled copy, and may lack important information or contain factual errors. SugarCRM reserves the right to change or update this document at any time.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/Endpoints_and_Entry_Points/index.html |
a1af84a30fab-0 | XSS Prevention
Overview
This document describes how to prevent cross-site scripting (XSS) attacks in Sugar customizations. XSS attacks occur when malicious entities are able to inject client-side scripts into web pages.
Best Practices
When creating custom code for Sugar, be sure to respect the following best practices. These rules serve to protect the elements of your customizations that are most susceptible to XSS vulnerabilities:
Create safe variables when injecting HTML via Handlebars templates or JavaScript methods such as: $(selector).html(variable), $(selector).before(variable), or $(selector).after(variable).
Avoid using triple-bracket (e.g. {{{variable}}}) syntax to allow unescaped HTML content in Handlebars templates.
Never use input from an unknown source as it may contain unsafe data.
Protect dynamic content, which may also contain unsafe data.
Please refer to the following sections for more information and examples that demonstrate these best practices.
Creating Safe Variables
You must always encode a variable before you inject or display it on a webpage. The piece that is not encoded should be isolated and marked as a safe string very carefully. The the following sections outline protecting your system when using JavaScript and Handlebars templates.
JavaScript
To ensure displayed JavaScript variables are safe, respect these two rules:
If you are displaying plain text without any HTML, use .text() instead of .html() with your selectors.
If your text contains HTML formatting, you can use .html()Â as long as it does not contain any dynamic data coming from a variable.
Vulnerable Setup
This is an example of bad code because it utilizes the .html() method to display a dynamic-value variable, leaving the JavaScript vulnerable to injection:
var inputData = $('#myInput').val(); // "<script>alert(0)</script>" | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/XSS_Prevention/index.html |
a1af84a30fab-1 | var inputData = $('#myInput').val(); // "<script>alert(0)</script>"
$(selector).html('This is the value: ' + inputData); // "This is the value: <script>alert(0)</script>"
Protected Setup
This is an example of good code, which uses the safe .text() method to protect the JavaScript from potential injection:
var status = 'safe';
$(selector).text('This is very ' + status); // "This is very safe"
This is also an acceptable approach, which uses the Handlebars.Utils.escapeExpression to safely escape the content:
var inputData = $('#myinput').val(); // "<script>alert(0)</script>"
var safeData = Handlebars.Utils.escapeExpression(inputData); // "<script>alert(0)</script>"
$(selector).html('This is the value: ' + safeData); // "This is the value: <script>alert(0)</script>"
Handlebars Templates
Handlebars, by default, handles the encoding of data passed to the template in double brackets (e.g. {{variable}}), however, it also allows you to bypass this encoding by using triple brackets (e.g. {{{variable}}}). Text passed via triple brackets will not be encoded. As a rule, do not use triple brackets. If you don't want Handlebars to encode a piece of a string, use double brackets and execute Handlebars.SafeString() in your JavaScript controller.Â
As an example, we will apply best practices to a complex use case with dynamic values that need to be encoded. For this example, we want to display a message similar to:
Congrats! You just created the record <a href="/#Accounts/abcd">ABCD</a> | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/XSS_Prevention/index.html |
a1af84a30fab-2 | The values ABCD and /#Accounts/abcd are dynamic values and, therefore, must be encoded. But the message must also be displayed as HTML, so the overall element cannot be entirely encoded. To address this use case, we must properly script the JavaScript controller and the Handlebars template.
The following JavaScript encodes the message's dynamic values, marks the displayed hyperlink as a safe string, and then outputs the safe message:
var record = {
id: 'abcd',
name: 'ABCD'
};
// escape `ABCD`
var safeName = Handlebars.Utils.escapeExpression(record.name);
// escape `abcd`
var safeId = Handlebars.Utils.escapeExpression(record.id);
// Mark the link as a SafeString now that the unsafe pieces are encoded and the content has safe HTML.
var link = new Handlebars.SafeString('<a href="/#Accounts/' + safeId + '">' + safeName . '</a>');
// This can be displayed with double brackets in the template because html parts will not be encoded.
this.safeMessage = new Handlebars.SafeString('Congrats! You just created the record ' + link + '.');
To display the safe message in the application, use the following syntax in your Handlebars template:
<div class="success">{{safeMessage}}</div>
Please refer to the HTML Escaping documentation on the Handlebars website for more information.Â
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/XSS_Prevention/index.html |
588235c25b15-0 | Web Server Configuration
Overview
This document serves as a guideline to harden the web server configuration with regard to running SugarCRM. Note that this is a guideline and certain settings will depend on your specific environment and setup. This guideline focuses on Apache web server as this is SugarCRM's primary supported web server. However, the recommendations in this document apply to all web servers in general.
Advisory ID: sugarcrm-sr-2015-003Revision: 1.1Last updated: 2015-10-01Â
SugarCRM .htaccess file
During installation, SugarCRM deploys an .htaccess file in SugarCRM's root folder. The content of this file may change during upgrades as well. The primary configuration directives managed by SugarCRM are focused around disabling direct access to certain directories and files. Secondly, the configuration contains specific URL rewrite rules which are required for SugarCRM.
Although this file can be used to ship most of the settings which are explained in this document to harden the web server, SugarCRM has chosen not to do so as most of them depend on the customer's setup which cannot be fully controlled by the SugarCRM application itself.
All directives which are managed by SugarCRM are placed between the following markers inside the .htaccess file:
# BEGIN SUGARCRM RESTRICTIONS
RedirectMatch 403 .*\.log$
...
# END SUGARCRM RESTRICTIONS
Customers can add additional directives if need. Make sure to put those directives outside of the above-mentioned markers. SugarCRM can rebuild during upgrades all directives enclosed in the above markers.
Securing .htaccess
Apache allows admins to drop in .htaccess files in any given directory. When a request comes in, Apache will scan the directory recursively for any .htaccess file and apply its configuration directives. This ability is orchestrated by the AllowOverride directive which is enabled by default on most Apache configurations. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/Web_Server_Configuration/index.html |
588235c25b15-1 | To disable this dynamic Apache configuration behavior, disable AllowOverride and make sure to copy paste the .htaccess file content as well.
<Directory "/var/www/html">
AllowOverride None
# BEGIN SUGARCRM RESTRICTIONS
RedirectMatch 403 .*\.log$
...
# END SUGARCRM RESTRICTIONS
</Directory>
When choosing for this security measure, make sure to verify if any changes have happened in the .htaccess after an upgrade. Those changes need to be applied manually back in the Apache configuration to ensure SugarCRM functions properly. Disabling the .htaccess file support also has a positive impact on the performance as Apache will no longer need to scan for the presence of .htaccess files.
Although Apache does not allow to download .htaccess files, to tighten the security around .htaccess, even more, the following directives can be added:
<Files ".ht*">
Order deny,allow
Deny from all
</Files>
Prevent version exposure
By default Apache web server exposes its version and OS details in most *nix distributions in both the HTTP response headers as well as on the default error pages. To prevent this behavior use the following configuration directives:
ServerSignature Off
ServerTokens Prod
 The exposure of the PHP version can be disabled in your php.ini file. When exposed an X-Powered-By response header will be added containing the PHP version information.
expose_php = Off
Another option is to unset the header explicitly in the Apache configuration:
<IfModule mod_headers.c>
Header unset X-Powered-By
</IfModule> | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/Web_Server_Configuration/index.html |
588235c25b15-2 | Header unset X-Powered-By
</IfModule>
Note that unsetting the Server header is not possible using this way. The web server will always respond with a Server header containing the string "Apache". If it is desired to remove this header as well, additional modules need to be used for this (i.e. mod_security can do this).
Directory listing and index page
Make sure to configure a default index page which should only be index.php for SugarCRM. This is mostly configured but worth checking. Additional SugarCRM does not require the directory browsing support and this is recommended to be disabled. This can be accomplished by removing Options Indexes and/or completely disable the mod_autoindex module.
Optionally additional Allow/Deny directives can be used to apply access lists to certain directories. It is not recommended to add additional authentication through Apache as SugarCRM already fully manages user authentication. The Allow/Deny directives can still be used to apply any IP access list if required by the customer.
The following example secures the root directory (default configuration), disable directory browsing and an additional IP access list is applied.
DocumentRoot "/var/www/html"
<Directory />
AllowOverride none
Order allow,deny
Deny from all
</Directory>
<Directory "/var/www/html">
DirectoryIndex index.php
Options -Indexes
Order deny,allow
Allow from 10.0.0.0/8
Deny from all
</Directory>
Additional Options directives
SugarCRM does not rely on both CGI and SSI and it is recommended to disable this functionality explicitly. Optionally the FollowSymLinks options can also be disabled depending on your directory setup.
<Directory "/var/www/html">
Options -ExecCGI -Includes -FollowSymLinks
</Directory>
Web server permissions | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/Web_Server_Configuration/index.html |
588235c25b15-3 | </Directory>
Web server permissions
Ensure your web server is configured to run as a dedicated non-privileged user. Certain *nix distributions use out of the box the user/group nobody. It is recommended to use a dedicated user/group instead.
User wwwrun
Group www
Ensure the configured user/group have the proper file and directory permissions for SugarCRM. See the installation/upgrade guide for more detailed instructions regarding the required permissions.
Disable unnecessary loadable modules
Apache is pluggable by means of loadable modules. To minimize the chances of becoming a victim of an attack it is recommended to disable all loadable modules which are not needed. SugarCRM recommends the following base Apache modules:
mod_authz_host
mod_dir
mod_expires
mod_rewrite
mod_headers
mod_mime
mod_alias
From an Apache perspective to disable a loadable module, it is sufficient to comment out the LoadModule directives. However certain *nix distribution has additional configuration scripts to manage the loaded Apache modules. Please refer to your *nix distribution for this.
Based on your setup additional Apache modules can be used. When using MPM prefork you will also need mod_php5 and when terminating secure HTTP connection on the web server directly also mod_ssl (see below).
HTTP methods
HTTP uses different methods (verbs) in requests. As per RFC-7231 for HTTP/1.1 different request methods are defined which serve the primary source of the request semantics. The following methods are used by SugarCRM:
For new REST API:
GET
POST
PUT
DELETE
HEAD (*)
OPTIONS (*)
Bootstrap, BWC access, old SOAP/REST API:
GET
POST
(*) Currently not in use, but may be implemented in the future. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/Web_Server_Configuration/index.html |
588235c25b15-4 | GET
POST
(*) Currently not in use, but may be implemented in the future.
The new REST API is accessed using the URL "/rest/vxx/â¦" where xxx represents the API version number. To harden the usage of the additional HTTP methods the following directives can be used for the new REST API endpoint while only allowing GET and POST on the legacy access.
<Directory "/var/www/html">
<LimitExcept GET POST>
Order deny,allow
Deny from all
</LimitExcept>
</Directory>
<Location "/rest">
<LimitExcept GET POST PUT DELETE>
Order deny,allow
Deny from all
</LimitExcept>
</Location>
<Location "/api/rest.php">
<LimitExcept GET POST PUT DELETE>
Order deny,allow
Deny from all
</LimitExcept>
</Location>
Instead of using the Limit directive, an alternative is using mod_allowmethods which is available since Apache 2.4. However this module is flagged as experimental.
Secure HTTP traffic
SugarCRM requires the usage of HTTPS transport without any exception. Depending on your setup you can terminate the secure connection on a separate endpoint (load balancer, dedicated HTTPS termination point) or directly on the web server(s). You will also need a valid private key and X.509 certificate. In most cases, the customer needs to acquire an X.509 certificate through a public certification authority of their choice. For internal deployments, this may not be necessary when a local PKI environment is available.
When terminating the secure connection directly on the Apache web server, mod_ssl is required. A dedicated VirtualHost needs to be configured on port 443 (standard HTTPS port). The following is a basic SSL/TLS configuration as a reference. More details are covered in the next paragraphs. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/Web_Server_Configuration/index.html |
588235c25b15-5 | <VirtualHost 1.2.3.4:443>
SSLEngine on
SSLCertificateFile /etc/pki/tls/certs/example.com.crt
SSLCertificateKeyFile /etc/pki/tls/certs/example.com.key
SSLCertificateChainFile /etc/pki/tls/certs/example_bundle.crt
ServerName crm.example.com
</VirtualHost>
Make sure to have your server name properly configured as it should match the X.509 certificate's CommonName (or one of the SNA's, subject alternative names). More information regarding the certificate requests including the certificate chain can be obtained from your certification authority.
Ensure to redirect all non-secure HTTP (port 80) traffic to the secure virtual host.
<VirtualHost *:80>
Redirect "/" "https://crm.example.com/"
</VirtualHost >
Cipher suite hardening
One of the crucial points of HTTPS is to force only secure cryptographic algorithms. Based on new future weaknesses which may be discovered in the future the recommended cipher suite settings can change. As per publish date of this document the usage of SSLv2 and SSLv3 is recommended to be disabled. The current safe secure transport protocols are TLSv1.0, TLSv1.1, and TLSv1.2 with properly configured cipher suites.
For proper deployment of Diffie-Hellman (DH) key exchange algorithms the following guidelines apply:
No longer use out-dated export cipher suites
Ensure the usage of Elliptic Curve Diffie-Hellman (ECDHE) based algorithms
Use of non-common Diffie-Hellman groups | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/Web_Server_Configuration/index.html |
588235c25b15-6 | Use of non-common Diffie-Hellman groupsÂ
More detail around the DH configuration and a detailed list of recommended cipher suites including web server configuration examples can be found at https://weakdh.org/sysadmin.html. Additionally, an online SSL/TLS checker can be used to generate a full report of your current configuration in case your web server is publically reachable. A recommended tool is https://www.ssllabs.com/ssltest/analyze.html. The output of this SSL/TLS test suite will guide you into further (optional) details which can be tweaked regarding your configuration (i.e. OCSP stapling, certificate pinning, â¦).
Please note that using the above instruction "perfect forward secrecy" will be enabled. This basically means that captured TLS traffic can only be decoded using the session key between a specific client and server. Nonperfect forwarding secrecy connections can always be decrypted by having access to only the server's private key. If the customer's setup has intermediate IDS/WAF systems to inspect traffic looking inside the secure traffic, having perfect forwarding secrecy configured may not be desirable.
Public trusted root CA's
It is recommended that the *nix system where Apache is running always has the latest public root CA (certification authority) files available to authenticate server certificates during the SSL/TLS handshake. Most *nix distributions take care of this through their online update process. If this is not the case, the system administrator is responsible to ensure the latest trusted root CA's are up-to-date. Out of the box, the SugarCRM application contacts the SugarCRM heartbeat and licensing server using a secure connection.
HSTS header | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/Web_Server_Configuration/index.html |
588235c25b15-7 | HSTS header
As all traffic requires HTTPS for SugarCRM, it is recommended to configure a global HSTS (HTTP Strict Transport Security) header. This is an additional opt-in security enhancement supported by most modern browsers. The HSTS will instruct the browser to always use HTTPS in the future for the given FQDN. More details regarding HSTS can be found here: https://www.owasp.org/index.php/HTTP_Strict_Transport_Security.
Before enabling the HSTS header, ensure that no other non-HTTPS website is running for the given FQDN and any subdomains.
Header always set Strict-Transport-Security \
"max-age=10886400; includeSubdomains; preload"
Optionally when your SugarCRM application is publically reachable, you can submit your FQDN on the preload which is maintained by Chrome and included by Firefox, Safari, Internet Explorer 11 and Edge browser. Understand the consequences and requirements to end up on the preload list. Once registered, this cannot be undone easily. Submissions for the HSTS preload list can be found at https://hstspreload.appspot.com.
CSP header
A Content Security Policy header can be added to offer additional protection against XSS (cross-site scripting). Most modern browsers support CSP and will apply the limitation as directed by the CSP header. The CSP header defines the allowed sources through different directives which are allowed regarding JScript, CSS, images, fonts, form actions, plugins, ⦠More information can be found at https://www.owasp.org/index.php/Content_Security_Policy.
The management of CSP headers can become complex and may depend on different types of customizations which can be deployed on the SugarCRM platform.Â
For now, CSP headers can be configured directly on the web server. A basic configuration looks like this:Â
Header always set Content-Security-Policy \ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/Web_Server_Configuration/index.html |
588235c25b15-8 | Header always set Content-Security-Policy \
"default-src 'self'; script-src 'self'"
Note:Â This is a syntax example of a CSP header and not a recommended value.
Older browsers use the header X-Content-Security-Policy or X-WebKit-CSP instead of the standardized one. The CSP header can also safely be added first in "report only" mode before deploying it in production using Content-Security-Policy-Report-Only.
Additional security headers
To prevent clickjacking an X-Frame-Options header can be added. This header can also be used to iframe the SugarCRM application inside another web site if required. This can be better controlled with the above mentioned CSP header. Both can coexist together but it is encouraged to used the CSP approach.
Header always set X-Frame-Options "SAMEORIGIN"
Header always set X-Frame-Options "ALLOW-FROM https://someothersite.com"
To protect against "drive-by download" attacks, it is encouraged to disable Content-Type sniffing. This is particularly targeted at Chrome and IE.
Header always set X-Content-Type-Options "nosniff"
Ensure XSS browser protection is enabled by adding the following header. By default, this feature should be enabled in every browser. In case it has been disabled, sending this header will re-enable it.
Header always set X-XSS-Protection "1; mode=block"
Secure cookie settings
Ensure the following settings are applied in php.ini to ensure legacy cookies are properly protected against XSS attacks and are only transmitted over a secure HTTPS connection.
session.cookie_httponly = 1
session.cookie_secure = 1
Additionally, the session.cookie_path can be tweaked if other applications are running on the same web server.
Security modules | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/Web_Server_Configuration/index.html |
588235c25b15-9 | Security modules
Additional Apache loadable security modules exist which can optionally be installed to better protect your system from malicious requests and/or DDOS attacks. The following modules are available for Apache 2.4:
mod_security - This module adds WAF (web application firewall) capabilities to your Apache setup. In combination with the OWASP CRS (core rule set) gives you a solid starting point for a WAF implementation.
mod_evasive - This module helps to prevent (D)DOS attacks
Covering both modules in details is out of the scope of this Security Response. Refer to the module documentation for additional details. In the future, SugarCRM may publish specific settings and fine-tuning for both modules.Â
Additional resources
Generic Apache security tipshttp://httpd.apache.org/docs/2.4/misc/security_tips.html
Online SSL/TLS testerhttps://www.ssllabs.com/ssltest/analyze.html
Useful HTTP headershttps://www.owasp.org/index.php/List_of_useful_HTTP_headers
Publication History
2015-10-01
Adding HTTP method restrictions
2015-09-08
Initial publication
A stand-alone copy of this document that omits the distribution URL is an uncontrolled copy and may lack important information or contain factual errors. SugarCRM reserves the right to change or update this document at any time.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/Web_Server_Configuration/index.html |
53ccb2ae0280-0 | Introduction
Overview
The Sugar Developer Guide is an essential resource for developers who are new to Sugar or to CRM and web-based applications. It describes how to configure and customize the Sugar platform for a broad range of tasks applicable to any organization that has a need to manage business relationships with people.
Prerequisites
Using and understanding the documentation contained in the Sugar Developer Guide requires basic programming and software development knowledge. Specifically, you should be familiar with the PHP general-purpose scripting language and the SQL programming language for accessing databases.
Understanding Sugar's Framework | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/index.html |
53ccb2ae0280-1 | Understanding Sugar's Framework
Designed as the most modern web-based CRM platform available today, Sugar has quickly become the business application standard for companies around the world. The Sugar application framework has a sophisticated extension model built into it, allowing developers to make significant customizations to the application in an upgrade-safe and modular manner. It is easy to modify the core files in the distribution; you should always check for an upgrade-safe way to make changes. Educating developers on how to make upgrade-safe customizations is one of the key goals of this Developer Guide. For more information on Sugar's structure, please review the architecture section.
Supported Platforms | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/index.html |
53ccb2ae0280-2 | Supported Platforms
Originally, Sugar® was written on the LAMP stack (i.e. Linux, Apache, MySQL, and PHP), but has since added support for every operating system on which the PHP programming language runs, for the Microsoft IIS web server, and for the Microsoft SQL Server, IBM® DB2®, and Oracle databases. For more information about supported software versions and recommended stacks, please refer to the main Supported Platforms page.
Sugar Products
Sugar has several CRM products available: Sugar Sell, Sugar Serve, and Sugar Enterprise, which are all sold under a commercial subscription agreement. These products are developed by the same development team using the same source tree with different modules and features available depending on the product. A comparison of each product's features is available in the License Types section of the User Management documentation in the Administration Guide.
Basic Development Rules for Sugar Products | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/index.html |
53ccb2ae0280-3 | Basic Development Rules for Sugar Products
Unless SugarCRM has given you express permission to do so, the following are what not to do when you are configuring, customizing or modifying this Sugar product:
Do not remove or alter any SugarCRM or Sugar copyright, trademark or proprietary notices that appear in the Sugar products.
Do not "fork" the Sugar software (e.g., take a copy of source code from this product and start independent development on it, creating a distinct and separate piece of software).
Do not modify, remove or disable any portion of SugarCRM's "Critical Control Software."
Do not combine or use the Sugar products with any code that is licensed under a prohibited license (e.g., AGPL, GPL v3, Creative Commons or another similar license that would "taint" the Sugar products and require you to share the source code for this product with a third party). | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/index.html |
53ccb2ae0280-4 | Do not use any part of the Sugar products for the purpose of building a competitive product or service or copying its features or user interface.
Development Tools
Sugar has a set of built-in tools that you can use to your advantage when troubleshooting or developing.
Developer Mode
Developer Mode will allow for Sugar to recompile cached files when the page is reloaded. The following file types are rebuilt:
Handlebar Templates (.hbt)
Smarty Templates (.tpl)
JavaScript Controllers (.js)
When Developer Mode is enabled, The Sidecar JavaScript library references the full JavaScript files located in ./sidecar/ rather than the concatenated and minified cached versions. You can turn on Developer Mode by navigating to Admin > System Settings. For more information, please refer to the System documentation.
Note: This setting should remain off unless developing because it will degrade system performance. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/index.html |
53ccb2ae0280-5 | Note: This setting should remain off unless developing because it will degrade system performance.
Diagnostic Tool
When troubleshooting issues, you may find the diagnostic tool to be helpful. This tool will export a zipped package containing the requested diagnostics and is available even if you are hosting your instance on Sugar's cloud service.
The diagnostic tool has the ability to export the following:
SugarCRM config.php
SugarCRM Custom directory
phpinfo()
MySQL - Configuration Table Dumps
MySQL - All Tables Schema
MySQL - General Information
MD5 info
Copy files.md5
Copy MD5 Calculated array
BeanList/BeanFiles files exist
SugarCRM Log File
Sugar schema output (VARDEFS)
You can use the diagnostic tool by navigating to Admin > Diagnostic Tool. For more information, please refer to the System documentation in the Administration Guide. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/index.html |
53ccb2ae0280-6 | Composer
When building applications, some developers prefer to use Composer to manage their external dependencies and make them more intuitive. For more information, please refer to the Composer documentation.
Â
TopicsDevelopment MethodologyAn overview of code development methodologies for Sugar platform customizationsComposerUsing Composer as a dependency management system for third party libraries.Delivery and Deployment Guide for EnterprisesGuide to customization deployment steps used by Sugar Professional Services when engaged in CRM projects.Sugar 12.3 to 13.0 Migration GuideThe purpose of this document is to provide insight to Sugar Developers for upgrading custom Sugar code, extensions, and integrations to the Sugar 13.0 (Q2 2023) release.
Last modified: 2023-05-23 16:27:13 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/index.html |
b7a111614d86-0 | Delivery and Deployment Guide for Enterprises
Overview
SugarCRM Professional Services has a set of best practices for managing instances, delivering upgraded customizations, and deploying those upgraded customizations into Sugar on-site for our Enterprise customers. The following is an example of deployment practices used by SugarCRM Professional Services team when engaged on Enterprise Sugar development projects. It does not list all possible customizations that can be made in the system, it is intended to be used as a guide for how to automate the deployment of certain types of customizations into an on-premise Sugar instance. The techniques below cannot be used with Sugar's cloud service.
Deploying Application Configuration and Metadata
Use Case: Deployment of System Settings
System settings are stored in various places. In this section, we will address each type of storage for settings, and how to migrate each.
Storage types:
config_override.php | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/Delivery_and_Deployment_Guide_for_Enterprises/index.html |
b7a111614d86-1 | Storage types:
config_override.php
This is a file stored in the Sugar root directory that allows for overriding core config values (found in config.php). In the UI, the main place to make changes to this is via Admin -> System Settings
database 'config' table
It is loaded, used, and accessible throughout the Sugar application through the Config API.
System Tab Settings
Forecasting Settings
Portal Settings
This is a simple key/value/category store. There aren't too many components that use this. Here are some:
Â
config_override.php
System considerations:
File System:
config_override.php is placed in Sugar web root directoryÂ
Scripts required
PHP | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/Delivery_and_Deployment_Guide_for_Enterprises/index.html |
b7a111614d86-2 | Scripts required
PHP
You will need to write a script to read the current config_override.php and merge the existing array with the new values you'd like to change. This can be done one time, and re-used for all future config_override.php changes
Â
Steps to migrate:
Assess the values to be changed, added, or removed
Write a script to read the existing config_override.php, make the changes to the array, and re-write the file back to the system.
Â
database 'config' table
System considerations:
Database:
The 'config' table stores all these values. They are stored in a very simple table schema.
Scripts required
PHP
Write a simple PHP script to use Sugar object API. See Figure 1
Â
Steps to migrate: | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/Delivery_and_Deployment_Guide_for_Enterprises/index.html |
b7a111614d86-3 | Â
Steps to migrate:
Write script to use our object API for config table changes (See Figure 1)
Copy script to Sugar root directory
Execute the script
Remove the scriptÂ
Screenshots:
Figure 1:
Â
Â
Use Case: Deployment of Reports
The customer creates a report in the Reports module. They would like to deploy that report so that end users can all access and run it.
System considerations:
Database
Row is inserted into the Reports module (saved_reports table)
(For new team combinations) Row is inserted into the team_sets table
(For new team combinations) Rows are inserted into the team_sets_teams table
Scripts required
SQL
Retrieve the relevant rows (saved_reports, team_sets, team_sets_teams) and create a SQL script to insert them.
Additional notes: | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/Delivery_and_Deployment_Guide_for_Enterprises/index.html |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.