id
stringlengths 14
16
| text
stringlengths 33
5.27k
| source
stringlengths 105
270
|
|---|---|---|
95472f48c6af-0 | /KBContents/config POST
Creates and/or updates the config settings for the KBContents module
Summary:
This endpoint is used to create and/or update the config settings for the KBContents module as json data.
It extends the core config endpoint by adding the functionality to process deleted languages and documents
related to them.
Query Parameters:
Param
Description
Optional
Input Example:
{
"languages":[{
"en":"English",
"primary":true
},{
"de":"German",
"primary":false
}],
"category_root":"31696245-0438-ff7a-9144-544f8c659daf",
"deleted_languages":["es","ru"]
}
Output Example:
{
"languages":[{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsconfig_POST/index.html |
95472f48c6af-1 | }
Output Example:
{
"languages":[{
"en":"English",
"primary":true
},{
"de":"German",
"primary":false
}],
"category_root":"31696245-0438-ff7a-9144-544f8c659daf",
"deleted_languages":["es","ru"]
}
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/KBContentsconfig_POST/index.html |
038c34a926a3-0 | /Administration/config/:category POST
Overview
[ADMIN] Set Configuration Settings for a Category.
Summary
This endpoint sets configuration values for a given category. This endpoint is only available to administrators.
Request
POST /Administration/config/:category
Â
Response Example
{
"a_config": "good"
}
Change Log
Version
Change
v11.13
Added Administration/config/:category 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/Administrationconfigcategory_POST/index.html |
a44e039e1917-0 | /Emails/:record GET
Overview
Retrieves an Emails record.
Fields
Name
Type
Description
<record field>
<record field type>
Returns the fields for the selected record.
from_collection
List
The email's sender.
to_collection
List
The email's recipients found in the TO field.
cc_collection
List
The email's recipients found in the CC field.
bcc_collection
List
The email's recipients found in the BCC field.
attachments_collection
List
The email's attachments.
Request | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_GET/index.html |
a44e039e1917-1 | List
The email's attachments.
Request
GET /Emails/a028341c-ba92-9343-55e7-56cf5beda121?fields=name,state,
{"name":"from_collection","fields":["email_address","email_address_id",
"parent_type","parent_id","parent_name"]},
{"name":"to_collection","fields":["email_address","email_address_id",
"parent_type","parent_id","parent_name"]},
{"name":"cc_collection","fields":["email_address","email_address_id",
"parent_type","parent_id","parent_name"]},
{"name":"bcc_collection","fields":["email_address","email_address_id",
"parent_type","parent_id","parent_name"]}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_GET/index.html |
a44e039e1917-2 | "parent_type","parent_id","parent_name"]},
{"name":"attachments_collection","fields":["name","filename","file_size",
"file_source","file_mime_type","file_ext","upload_id"]}
Response
{
"id": "a028341c-ba92-9343-55e7-56cf5beda121",
"state": "Archived",
"name": "Re: Discuss Proposal",
"from_collection": {
"next_offset": {
"from": -1
},
"records": [{
"id": "ec113d14-7d27-11e7-a951-3c15c2d582c6",
"email_address": "[email protected]", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_GET/index.html |
a44e039e1917-3 | "email_address": "[email protected]",
"email_address_id": "ec05a896-7d27-11e7-a51e-3c15c2d582c6",
"parent_type": "Leads",
"parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6",
"parent_name": "Tom Davis",
"_acl": {
"fields": {}
},
"_link": "from",
"_module": "EmailParticipants"
}]
},
"to_collection": {
"next_offset": {
"to": -1
},
"records": [{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_GET/index.html |
a44e039e1917-4 | "to": -1
},
"records": [{
"id": "ec0f1278-7d27-11e7-8d1f-3c15c2d582c6",
"email_address": "[email protected]",
"email_address_id": "ec0fb516-7d27-11e7-b7ad-3c15c2d582c6",
"parent_type": "Users",
"parent_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
"parent_name": "Sarah Smith",
"_acl": {
"fields": {}
},
"_link": "to",
"_module": "EmailParticipants"
}]
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_GET/index.html |
a44e039e1917-5 | "_module": "EmailParticipants"
}]
},
"cc_collection": {
"next_offset": {
"cc": -1
},
"records": [{
"id": "eafa7e9a-7d27-11e7-aa2b-3c15c2d582c6",
"email_address": "[email protected]",
"email_address_id": "ea1cec7e-7d27-11e7-9845-3c15c2d582c6",
"parent_type": "Users",
"parent_id": "e087e79a-7d27-11e7-b02c-3c15c2d582c6",
"parent_name": "Brian Roland", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_GET/index.html |
a44e039e1917-6 | "parent_name": "Brian Roland",
"_acl": {
"fields": {}
},
"_link": "cc",
"_module": "EmailParticipants"
}, {
"id": "df5eb204-7d27-11e7-b363-3c15c2d582c6",
"email_address": "[email protected]",
"email_address_id": "ddf1d9e6-7d27-11e7-bb17-3c15c2d582c6",
"parent_type": "",
"parent_id": "",
"parent_name": "",
"_acl": {
"fields": {}
},
"_link": "cc",
"_module": "EmailParticipants"
}] | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_GET/index.html |
a44e039e1917-7 | "_module": "EmailParticipants"
}]
},
"bcc_collection": {
"next_offset": {
"bcc": -1
},
"records": []
},
"attachments_collection": {
"next_offset": {
"attachments": -1
},
"records": [{
"id": "afe9702e-53a3-0efb-6bbe-56c3580885ef",
"name": "Quote.pdf",
"filename": "Quote.pdf",
"upload_id": "",
"file_mime_type": "application/pdf",
"file_size": 158589,
"file_source": "DocumentRevisions",
"file_ext": "pdf" | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_GET/index.html |
a44e039e1917-8 | "file_ext": "pdf"
"_acl": {
"fields": {}
},
"_link": "attachments",
"_module": "Notes"
}]
}
"_acl": {
"fields": [
]
},
"_module": "Emails"
}
Change Log
Version
Change
v10
Added /Emails/:record 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/Emailsrecord_GET/index.html |
c90b1536aa0b-0 | /integrate/<module>/:sync_key_field_name/:sync_key_field_value GET
Overview
Retrieves the record with the given sync_key_field_name.
Request Arguments
Name
Type
Description
Required
module
String
The module the record belongs to
True
sync_key_field_name
String
The name of the field that contains sync_key_field_value (the default field is named sync_key but can be renamed via code customization)
True
sync_key_field_value
String
A unique ID for the record identifying it in an external system
True
Request
/integrate/<module>/:sync_key_field_name/:sync_key_field_value
Response Arguments
Body: formatted JSON object.
Response
Successful Response
Status 200
Failed Response
Status 422
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Integratemodulesync_key_field_namesync_key_field_value_GET/index.html |
c90b1536aa0b-1 | Response
Successful Response
Status 200
Failed Response
Status 422
{
"error": "invalid_parameter",
"error_message": "Could not find record with :sync_key_field_name::sync_key_field_value in module: <module>"
}
Change Log
Version
Change
v11_10
Added /integrate/<module>/:sync_key_field_name/:sync_key_field_value 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/Integratemodulesync_key_field_namesync_key_field_value_GET/index.html |
b9ecbc928f06-0 | /<module>/favorites POST
Overview
Opportunity Favorites Help
Summary
This endpoint returns all the favorite Quotes/Revenue Line Items in alphabetical order to be displayed in the
"Product Catalog Quick Picks" dashlet.
Request Arguments
Name
Type
Description
Required
pageNum
integer
An integer attribute in the payload data object which gets the page number for which the items need to be
displayed based on the current page or the page clicked.
False
Request
{
pageNum: 0
}
Response Arguments
Name
Type
Description
<config field>
<config field type>
The list of config fields will be returned.
Response
{
"totalPages":5,
"pageNum":0,
"max_num":8, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html |
b9ecbc928f06-1 | "pageNum":0,
"max_num":8,
"records":[
{
"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,
"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/modulefavorites_POST/index.html |
b9ecbc928f06-2 | "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, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html |
b9ecbc928f06-3 | "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"
},
{
"id":"c18e0448-c7f2-11e8-86b0-7831c1c14620",
"name":"Arla Gadget",
"date_entered":"2018-10-04 16:28:37", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html |
b9ecbc928f06-4 | "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":"c18b8b64-c7f2-11e8-8c1a-7831c1c14620",
"mft_part_num":"24\/7 Couriers 795391XYZ987",
"vendor_part_num":null,
"date_cost_price":null, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html |
b9ecbc928f06-5 | "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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html |
b9ecbc928f06-6 | "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, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html |
b9ecbc928f06-7 | "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",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"403.000000",
"discount_price":"927.000000",
"list_price":"927.000000",
"cost_usdollar":"403.000000", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html |
b9ecbc928f06-8 | "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"
},
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html |
b9ecbc928f06-9 | "base_rate":"1.000000"
},
{
"id":"c186a612-c7f2-11e8-9fee-7831c1c14620",
"name":"Bradford 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/modulefavorites_POST/index.html |
b9ecbc928f06-10 | "category_id":"c185dbb0-c7f2-11e8-a6b7-7831c1c14620",
"mft_part_num":"Mississippi Bank Group 133834XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"528.000000",
"discount_price":"533.333333",
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html |
b9ecbc928f06-11 | "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":"c1b4680e-c7f2-11e8-9380-7831c1c14620",
"name":"Brain Gadget",
"date_entered":"2018-10-04 16:28:37", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html |
b9ecbc928f06-12 | "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":"Smallville Resources Inc 362299XYZ987",
"vendor_part_num":null,
"date_cost_price":null, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html |
b9ecbc928f06-13 | "date_cost_price":null,
"cost_price":"370.000000",
"discount_price":"854.370000",
"list_price":"863.000000",
"cost_usdollar":"370.000000",
"discount_usdollar":"854.370000",
"list_usdollar":"863.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"10.00",
"qty_in_stock":106,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"PercentageDiscount", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html |
b9ecbc928f06-14 | "pricing_formula":"PercentageDiscount",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"base_rate":"1.000000"
},
{
"id":"c1baf0e8-c7f2-11e8-ab05-7831c1c14620",
"name":"Carley 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, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html |
b9ecbc928f06-15 | "deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c1b8e4ec-c7f2-11e8-b435-7831c1c14620",
"mft_part_num":"Hollywood Diner Ltd 10023XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"554.000000",
"discount_price":"559.595960",
"list_price":"927.000000",
"cost_usdollar":"554.000000",
"discount_usdollar":"559.595959", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html |
b9ecbc928f06-16 | "discount_usdollar":"559.595959",
"list_usdollar":"927.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"30.00",
"qty_in_stock":58,
"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"
},
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html |
b9ecbc928f06-17 | "base_rate":"1.000000"
},
{
"id":"c1b77544-c7f2-11e8-8347-7831c1c14620",
"name":"Carma 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/modulefavorites_POST/index.html |
b9ecbc928f06-18 | "category_id":"c1b3bf58-c7f2-11e8-92e7-7831c1c14620",
"mft_part_num":"Sea Region Inc 773472XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"332.000000",
"discount_price":"745.000000",
"list_price":"822.000000",
"cost_usdollar":"332.000000",
"discount_usdollar":"745.000000",
"list_usdollar":"822.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"35.00", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html |
b9ecbc928f06-19 | "website":null,
"weight":"35.00",
"qty_in_stock":1,
"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"
},
{
"id":"c1b98c9e-c7f2-11e8-9740-7831c1c14620",
"name":"Catrina Gadget",
"date_entered":"2018-10-04 16:28:37", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html |
b9ecbc928f06-20 | "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":"c1b8e4ec-c7f2-11e8-b435-7831c1c14620",
"mft_part_num":"Jungle Systems Inc 273034XYZ987",
"vendor_part_num":null,
"date_cost_price":null, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html |
b9ecbc928f06-21 | "date_cost_price":null,
"cost_price":"577.000000",
"discount_price":"582.770000",
"list_price":"946.000000",
"cost_usdollar":"577.000000",
"discount_usdollar":"582.770000",
"list_usdollar":"946.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"13.00",
"qty_in_stock":105,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"PercentageMarkup", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html |
b9ecbc928f06-22 | "pricing_formula":"PercentageMarkup",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"base_rate":"1.000000"
}
]
}
Change Log
Version
Change
v10
Added /Opportunities/favorites 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/modulefavorites_POST/index.html |
a3697caa9137-0 | /Administration/packages/:unFile DELETE
Overview
[ADMIN] PackageManager delete a package.
Summary
Delete the specified package. Package 'unFile' hash must be provided. Package 'unFile' hash could be found in staging package list.
Response
Returns http status 200 OK if request is successful. Otherwise returns http status 4xx with errors.
{
"error": "delete_package_error",
"error_message": "Could not find package file."
}
Change Log
Version
Change
v11.8
Added /Administration/packages/:unFile 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/AdministrationpackagesunFile_DELETE/index.html |
3fb818b38cd3-0 | /Administration/aws POST
Overview
[ADMIN] Set Amazon Web Services configs in Sugar Serve.
Summary
This endpoint sets configuration values for Amazon Web Services. This endpoint is only available to administrators of Sugar Serve.
Request Arguments
Name
Type
Description
Required
aws_connect_instance_name
String
The name of the AWS Connect instance
False
aws_connect_region
String
The region assigned to the AWS Connect instance
False
Response
{
"aws_connect_instance_name": "my-aws-instance",
"aws_connect_region": "us-east-2"
}
Change Log
Version
Change
v11_10
Added /Administration/aws 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/Administrationaws_POST/index.html |
bd8482107c49-0 | /pmse_Inbox/settings PUT
Overview
Update settings for the SugarBPMTM engine
Summary
This endpoint updates settings for the SugarBPMTM engine
Request Arguments
Name
Type
Description
Required
data
array
Key/value map of config keys and their associated values for the SugarBPMTM engine to update
false
Response Arguments
Name
Type
Description
success
boolean
Result of update
data
object
Key/Value map of config keys and their new values
Response
{
"success":true,
"data":
{
"logger_level":"critical",
"error_number_of_cycles":"10",
"error_timeout":"40"
}
}
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_Inboxsettings_PUT/index.html |
2235c0c322bc-0 | /password/request GET
Overview
Sends an email request to reset a users password.
Request Arguments
Name
Type
Description
Required
email
String
The email of the user.
True
username
String
The username of the user.
True
Request
http://{site_url}/rest/v10/password/request?email=admin%40sugar.crm&username=admin
Note: GET endpoint parameters are passed in the form of a query string.
Response Arguments
Name
Type
Description
Success
boolean
Returns the result of sending the email.
Response
true
Change Log
Version
Change
v10
Added /password/request POST endpoint. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/passwordrequest_GET/index.html |
2235c0c322bc-1 | Change
v10
Added /password/request 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/passwordrequest_GET/index.html |
e878f03a9c41-0 | /pmse_Inbox/clearLog/:typelog PUT
Overview
Clear the PMSE.log file log
Summary
This endpoint clears the contents of the PMSE.log file
Request Arguments
There are no request arguments for this endpoint
Response Arguments
Name
Type
Description
none
boolean
Result of the clear operation
Response
true
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_InboxclearLogtypelog_PUT/index.html |
425de0069006-0 | /<module>/customfield/:field DELETE
Overview
Delete a custom field for a specified module.
Summary
This endpoint is used to delete a custom field for a specified module.
Request Arguments
This endpoint does not accept any request arguments.
Response
{
"name": "ai_conv_score_c"
}
Response Codes and Error Messages
All successful responses should return 200.
This API returns the following error responses:
403 (SugarAPIExceptionNotAuthorized): Sent if the user attempts to access a module which they are forbidden to access.
404 (SugarApiExceptionNot Found): Sent if the requested field is not found.
422 (SugarApiExceptionInvalidParameter): Sent if the module and/or field are invalid.
500 (SugarApiExceptionError): Sent if there's an unknown error that causes the custom field to not be deleted in the module. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulecustomfieldfield_DELETE/index.html |
425de0069006-1 | Change Log
Version
Change
v11.11
Added /<module>/customfield/:field 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/modulecustomfieldfield_DELETE/index.html |
31b2c66f5c38-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 |
af90fe7bf1b8-0 | /<module>/:record/link/activities/filter GET
Activities on a module's list view
Summary:
This endpoint lists activities across a particular module in the system. It does not use a subscription model unlike the other endpoints. It can be queried as a regular bean collection, but without search, ordering or filtering.
Query Parameters:
ParamDescriptionOptionalmax_numA maximum number of records to returnOptionaloffsetHow many records to skip over before records are returnedOptional
Input Example:
This endpoint does not accept any input
Output Example:
{
"next_offset": 20, This will be set to -1 when there are no more records after this "page".
"records": [{
"id": "22fb8b16-de1d-f1dc-b15b-51240efde177", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinkactivitiesfilter_GET/index.html |
af90fe7bf1b8-1 | "date_entered": "2013-02-19T23:47:11+00:00",
"date_modified": "2013-02-19T23:47:11+00:00",
"created_by": "1",
"deleted": "0",
"parent_id": "f5bb0331-2c0f-5c7c-b4db-5123caac0056",
"parent_type": "Contacts",
"activity_type": "post", This will be the type of activity performed.
"data": {
"value": "This is a test post on a contact I'm subscribed to."
},
"comment_count": 0, This will be set to the total number of comments on the post. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinkactivitiesfilter_GET/index.html |
af90fe7bf1b8-2 | "last_comment": { This will be the last comment on the post, which can be used to create a comment model on the frontend.
"deleted": 0,
"data": []
},
"fields": [],
"first_name": null,
"last_name": "Administrator",
"created_by_name": " Administrator" This will be the locale-formatted full name of the user.
}, ... ]
}
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/modulerecordlinkactivitiesfilter_GET/index.html |
f8a23defce93-0 | /DataArchiver/:id/run POST
Overview
[ADMIN] Performs the archiving process.
Summary
Performs the archiving process for the given archive definition. This endpoint is only available to administrators.
Request Arguments
This endpoint does not accept any request arguments.
Response
This API returns the ID of the created ArchiveRun bean.
Change Log
Version
Change
v11_11
Added /DataArchiver/:id/run 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/DataArchiveridrun_POST/index.html |
9ae1855d51d4-0 | /Activities GET
Activities on the home page
Summary:
This endpoint lists activities across the entire sytstem. It uses a subscription model, and can be queried like a normal bean collection, but without search, ordering or filtering.
Query Parameters:
ParamDescriptionOptionalmax_numA maximum number of records to returnOptionaloffsetHow many records to skip over before records are returnedOptional
Input Example:
This endpoint does not accept any input
Output Example:
{
"next_offset": 20, This will be set to -1 when there are no more records after this "page".
"records": [{
"id": "22fb8b16-de1d-f1dc-b15b-51240efde177",
"date_entered": "2013-02-19T23:47:11+00:00", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Activities_GET/index.html |
9ae1855d51d4-1 | "date_modified": "2013-02-19T23:47:11+00:00",
"created_by": "1",
"deleted": "0",
"parent_id": "f5bb0331-2c0f-5c7c-b4db-5123caac0056",
"parent_type": "Contacts",
"activity_type": "post", This will be the type of activity performed.
"data": {
"value": "This is a test post on a contact I'm subscribed to."
},
"comment_count": 0, This will be set to the total number of comments on the post.
"last_comment": { This will be the last comment on the post, which can be used to create a comment model on the frontend.
"deleted": 0, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Activities_GET/index.html |
9ae1855d51d4-2 | "deleted": 0,
"data": []
},
"fields": [],
"first_name": null,
"last_name": "Administrator",
"created_by_name": " Administrator" This will be the locale-formatted full name of the user.
}, ... ]
}
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/Activities_GET/index.html |
7d5caa6efb6b-0 | /Administration/elasticsearch/routing GET
Overview
[ADMIN] Elasticsearch index routing
Summary
This endpoint returns an overview of the current read and write indices per module. This routing information is
based on the configured index routing strategies and the index configuration per module. Note that this output
shows the default routing only as no context is available to determine dynamic routing strategies. This endpoint
is only available to administrators.
Response
{
"Contacts":{
"strategy":"static",
"routing":{
"write_index":"autobr2583_contacts",
"read_indices":[
"autobr2583_contacts"
]
}
},
"Accounts":{
"strategy":"static",
"routing":{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationelasticsearchrouting_GET/index.html |
7d5caa6efb6b-1 | "strategy":"static",
"routing":{
"write_index":"autobr2583_shared",
"read_indices":[
"autobr2583_shared"
]
}
},
"Emails":{
"strategy":"rolling",
"routing":{
"write_index":"autobr2583_emails_201503",
"read_indices":[
"autobr2583_emails_201503",
"autobr2583_emails_201502",
"autobr2583_emails_201501"
]
}
}
}
Change Log
Version
Change
v10
Added /Administration/elasticsearch/routing GET endpoint. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationelasticsearchrouting_GET/index.html |
7d5caa6efb6b-2 | Added /Administration/elasticsearch/routing 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/Administrationelasticsearchrouting_GET/index.html |
ff573d31bd3d-0 | /logger POST
Overview
Logs a message to the Sugar Log
Request Arguments
Name
Type
Description
Required
level
String
The log level
True
message
String
The message to log
True
channel
String
Prefix for the log message, defaults to Main
false
Response Arguments
Name
Type
Description
status
bool
if the message was logged
Response
{
"status":true,
}
Change Log
Version
Change
v10
Added /logger 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/logger_POST/index.html |
c2e09502a410-0 | /Teams/: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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_DELETE/index.html |
c2e09502a410-1 | "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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_DELETE/index.html |
c2e09502a410-2 | },
{
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_DELETE/index.html |
c2e09502a410-3 | "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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_DELETE/index.html |
c2e09502a410-4 | "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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_DELETE/index.html |
c2e09502a410-5 | "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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_DELETE/index.html |
c2e09502a410-6 | "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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_DELETE/index.html |
c2e09502a410-7 | "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/Teamsrecordlinklink_nameremote_id_DELETE/index.html |
c2e09502a410-8 | "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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_DELETE/index.html |
c2e09502a410-9 | "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/: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/Teamsrecordlinklink_nameremote_id_DELETE/index.html |
8127fafaa9d8-0 | /<module>/filter GET
Overview
Lists filtered records.
Summary
This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields
and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.
If both a filter definition and a filter id are passed, the two filters will be joined with an AND.
Care will need to be taken to make sure that any filters used have 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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_GET/index.html |
8127fafaa9d8-1 | Name
Type
Description
Required
filter
String
The filter expression. Filter expressions are explained below.
Note that JSON-encoded filters can be specified as query parameters
in one of two ways for GET requests:
By specifying individual filter arguments as distinct parameters.
Example: filter[0][id]=1.
By specifying the whole filter as a single JSON-encoded string.
Note that this syntax is currently not supported on certain modules.
Example: filter=[{"id":"1"}].
False
filter_id
String
Identifier for a preexisting filter. If filter is also set, the two
filters are joined with an AND.
False
max_num
Integer | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_GET/index.html |
8127fafaa9d8-2 | 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. Each field may be represented either by string, or by map
containing field name and additional field parameters (applicable to link and collection fields).
The fields id and date_modified will always be returned.
Example: name,account_type,description,{"name":"opportunities","fields":["id","name","sales_status"],"order_by":"date_closed:desc"}
For more details on additional field parameters, see | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_GET/index.html |
8127fafaa9d8-3 | For more details on additional field parameters, see
Relate API and
Collection API.
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
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
q
String | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_GET/index.html |
8127fafaa9d8-4 | False
q
String
A search expression, will search on this module. Cannot be used at the same time as a filter expression or id.
False
deleted
Boolean
Boolean to show deleted records in the result set.
False
nulls_last
Boolean
Boolean to return records with null values in order_by fields last in the result set.
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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_GET/index.html |
8127fafaa9d8-5 | "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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_GET/index.html |
8127fafaa9d8-6 | 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.
$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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_GET/index.html |
8127fafaa9d8-7 | $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" | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_GET/index.html |
8127fafaa9d8-8 | {
"$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
Integer | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_GET/index.html |
8127fafaa9d8-9 | 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
{
"next_offset":-1,
"records":[
{
"id":"fa300a0e-0ad1-b322-9601-512d0983c19a",
"name":"Dale Spivey",
"date_modified":"2013-02-28T05:03:00+00:00",
"description":"",
"opportunities": [
{
_module: "Opportunities", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_GET/index.html |
8127fafaa9d8-10 | {
_module: "Opportunities",
"id": "b0701501-1fab-8ae7-3942-540da93f5017",
"name": "360 Vacations - 228 Units",
"date_modified": "2014-09-08T16:05:00+03:00",
"sales_status": "New"
},
],
"_acl": {
"fields": {
}
}
},
{
"id":"95e17367-9b3d-0e26-22dc-512d0961fedf",
"name":"Florence Haddock",
"date_modified":"2013-02-26T19:12:00+00:00",
"description":"",
"opportunities": [
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_GET/index.html |
8127fafaa9d8-11 | "description":"",
"opportunities": [
{
_module: "Opportunities"
date_modified: "2014-09-08T16:05:00+03:00"
id: "9ce7c088-8ee4-7cd3-18f1-540da944d4c0"
name: "360 Vacations - 312 Units"
sales_status: "New"
},
],
"_acl": {
"fields": {
}
}
}
]
}
Change Log
Version
Change
v10
Added /<module>/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/modulefilter_GET/index.html |
16533e18f221-0 | /RevenueLineItems/:record/quote POST
Convert a Revenue Line Item to a quote.
Summary:
This endpoint is used to convert a single RevenueLineItem to a quote
Query Parameters:
Param
Description
Optional
record
Which Revenue Line Item to convert
false
Valid Urls:
/rest/v10/RevenueLineItems/:record/quote/
Output Example:
{
id:"123-456-789-0",
name:"My Test Quote"
}
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/RevenueLineItemsrecordquote_POST/index.html |
53cd55f66e2e-0 | /Dashboards POST
Create a new Home dashboard.
Notice
The behavior of this endpoint has changed in v11. For a description of behavior in v11, refer to
POST /<module>. If you continue to use v10 of the API,
your REST calls should behave as below. But, it is advisable to upgrade to v11.Migrating to v11:
Recommended Replacement: POST /Dashboards
The Home module is no longer the default dashboard_module. To specify the Home
module, include it in the Request Body.v11: POST /Dashboards with the following in the Request Body:
{"dashboard_module":"Home"}
Request Arguments
Name
Type
Description
Required
<record field>
<record field type>
The name value list of fields to populate.
True
Request
{
"name": "New Home Dashboard", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboards_POST/index.html |
53cd55f66e2e-1 | True
Request
{
"name": "New Home Dashboard",
"dashboard_module": "Home",
"view_name": "",
"metadata": {
"components": [{
"rows": [[{
"width": 12,
"view": {
"limit": 10,
"visibility": "user",
"label": "Active Tasks",
"type": "active-tasks",
"module": null,
"template": "tabbed-dashlet"
}
}]],
"width": 12
}]
}
}
Response Arguments
Name
Type
Description
<record field>
<record field type>
Returns the fields for the newly created dashboard.
Response
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboards_POST/index.html |
53cd55f66e2e-2 | <record field type>
Returns the fields for the newly created dashboard.
Response
{
"id": "4ccda6fa-fa02-9c8e-215f-56cf72f98fcb",
"name": "New Home Dashboard",
"date_entered": "2016-02-25T13:30:51-08:00",
"date_modified": "2016-02-25T13:30:51-08:00",
"modified_user_id": "1",
"modified_by_name": "Administrator",
"created_by": "1",
"created_by_name": "Administrator",
"description": "",
"deleted": false,
"dashboard_module": "Home",
"view_name": "",
"metadata": { | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboards_POST/index.html |
53cd55f66e2e-3 | "view_name": "",
"metadata": {
"components": [
{
"rows": [
[
{
"width": 12,
"view": {
"limit": 10,
"visibility": "user",
"label": "Active Tasks",
"type": "active-tasks",
"module": null,
"template": "tabbed-dashlet"
}
}
]
],
"width": 12
}
]
},
"following": "",
"my_favorite": false,
"tag": [],
"assigned_user_id": "1",
"assigned_user_name": "Administrator",
"_acl": {
"fields": {}
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboards_POST/index.html |
53cd55f66e2e-4 | "_acl": {
"fields": {}
},
"view": "",
"_module": "Dashboards"
}
Change Log
Version
Change
v11
Behavior has changed. Please see POST /Dashboards
for the designated replacement.
v10
Added /Dashboards 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/Dashboards_POST/index.html |
7537e8f659ec-0 | /Emails/:record PUT
Overview
Update an existing Emails record.
Summary
Used for updating an archived email, updating a draft to send later, or sending a draft.
Updating an Archived Email
Request Arguments
Name
Type
Description
Required
message_uid
String
Only use this field for updating emails imported from an IMAP server, as this is the email's IMAP UID.
False
assigned_user_id
String
The assigned user's ID.
False
parent_type
String
The parent record's module.
False
parent_id
String
The parent record's ID.
False
team_name
List | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
7537e8f659ec-1 | False
team_name
List
List of teams that can access the email.
False
Request
{
"assigned_user_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
"parent_type": "Leads",
"parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6",
"team_name": [{
"id": "1",
"display_name": "Global",
"name": "Global",
"name_2": "",
"primary": true,
"selected": false
}]
}
Response
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
7537e8f659ec-2 | "selected": false
}]
}
Response
{
"id": "a028341c-ba92-9343-55e7-56cf5beda121",
"date_entered": "2016-02-25T11:53:07-08:00",
"created_by": "9c61c46a-a7c5-df71-481c-51d48232f820",
"created_by_name": "Sarah Smith",
"date_modified": "2016-02-25T11:53:07-08:00",
"modified_by_name": "Sarah Smith",
"modified_user_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
"deleted": false, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
7537e8f659ec-3 | "deleted": false,
"assigned_user_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
"assigned_user_name": "Sarah Smith",
"state": "Archived",
"name": "Re: Discuss Proposal",
"description": "Now is a good time",
"description_html": "<p>Now is a good time</p>",
"date_sent": "2012-02-17T06:53:00-08:00",
"message_id": "",
"message_uid": "",
"reply_to_status": false,
"total_attachments": 1,
"parent_name": "Tom Davis",
"parent_type": "Leads", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
7537e8f659ec-4 | "parent_type": "Leads",
"parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6"
"team_count": "",
"team_name": [{
"id": 1,
"name": "Global",
"name_2": "",
"primary": true,
"selected": false
}],
"my_favorite": false,
"_acl": {
"fields": {}
},
"_module": "Emails"
}
Updating a Draft
Request Arguments
Name
Type
Description
Required
outbound_email_id
String
The ID of the chosen SMTP configuration for sending an email. Only use this field when saving a draft | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
7537e8f659ec-5 | or sending an email. The user's default SMTP configuration is used if one hasn't been chosen prior to
sending.
False
name
String
The email's subject.
False
description_html
String
The email's HTML body.
False
description
String
The email's plain text body. This field is not necessary unless the text body is different from the HTML
body.
False
reply_to_id
String
Only use this field when saving a draft or sending an email that is a reply to another email. This is
the ID of that other email.
False
parent_type
String | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
7537e8f659ec-6 | False
parent_type
String
The parent record's module.
False
parent_id
String
The parent record's ID.
False
to
Object
The email's recipients found in the TO field. Existing EmailParticipants records cannot be used; only
the create and delete actions are supported. Metadata about each recipient is required to
link the records.
parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
or Users, out out of the box. These fields are not necessary if only an email address is known
for the recipient.
email_address_id is the ID of the email address the recipient used in the email. To get | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
7537e8f659ec-7 | the ID of the email address, first make a request to /EmailAddresses POST. If this
argument is not provided, then the primary email address of the parent record is used.
False
cc
Object
The email's recipients found in the CC field. Existing EmailParticipants records cannot be used; only
the create and delete actions are supported. Metadata about each recipient is required to
link the records.
parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
or Users, out out of the box. These fields are not necessary if only an email address is known
for the recipient.
email_address_id is the ID of the email address the recipient used in the email. To get | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
7537e8f659ec-8 | the ID of the email address, first make a request to /EmailAddresses POST. If this
argument is not provided, then the primary email address of the parent record is used.
False
bcc
Object
The email's recipients found in the BCC field. Existing EmailParticipants records cannot be used; only
the create and delete actions are supported. Metadata about each recipient is required to
link the records.
parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
or Users, out out of the box. These fields are not necessary if only an email address is known
for the recipient.
email_address_id is the ID of the email address the recipient used in the email. To get | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
7537e8f659ec-9 | the ID of the email address, first make a request to /EmailAddresses POST. If this
argument is not provided, then the primary email address of the parent record is used.
False
attachments
Object
The email's attachments. Existing Notes records cannot be used as email attachments; only the
create and delete actions are supported. Metadata about each attachment is required to
link the records.
filename_guid is the temporary file ID for an uploaded file to attach as a Notes record.
upload_id is the ID of an existing file that the Notes record should reference as the
attachment. This allows files to be shared by multiple Notes records, to preserve space.
When using upload_id, file_source should be provided to indicate from where the | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
7537e8f659ec-10 | When using upload_id, file_source should be provided to indicate from where the
file originated. The value should be the module of the record that shares its ID with the file.
So when an attachment comes from an email template, file_source should be
EmailTemplates. And when an attachment comes from a document, file_source should
be DocumentRevisions.
False
Request
{
"outbound_email_id": "b80adf1a-7d78-11e7-855a-3c15c2d582c6",
"name": "Re: Discuss Proposal (new time)",
"description_html": "<p>I will call you in 10 minutes.</p>",
"parent_type": "Contacts", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
7537e8f659ec-11 | "parent_type": "Contacts",
"parent_id": "79b9c194-7d79-11e7-8fc5-3c15c2d582c6",
"to": {
"create": [{
"parent_type": "Contacts",
"parent_id": "79b9c194-7d79-11e7-8fc5-3c15c2d582c6"
}],
"delete": [
"ea1cec7e-7d27-11e7-9845-3c15c2d582c6"
]
},
"cc": {
"delete": [
"eafa7e9a-7d27-11e7-aa2b-3c15c2d582c6" | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
7537e8f659ec-12 | ]
},
"attachments": {
"create": [{
"upload_id": "a028341c-ba92-9343-55e7-56cf5beda121",
"name": "Contract.pdf",
"filename": "Contract.pdf",
"file_source": "DocumentRevisions"
}],
"delete": [
"e087e79a-7d27-11e7-b02c-3c15c2d582c6"
]
}
}
Response
{
"id": "f3c85966-7d27-11e7-9e9e-3c15c2d582c6",
"date_entered": "2016-02-25T11:53:07-08:00", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
7537e8f659ec-13 | "created_by": "9c61c46a-a7c5-df71-481c-51d48232f820",
"created_by_name": "Sarah Smith",
"date_modified": "2016-02-25T12:53:07-08:00",
"modified_by_name": "Sarah Smith",
"modified_user_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
"deleted": false,
"assigned_user_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
"assigned_user_name": "Sarah Smith",
"state": "Draft", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
7537e8f659ec-14 | "state": "Draft",
"outbound_email_id": "b80adf1a-7d78-11e7-855a-3c15c2d582c6",
"name": "Re: Discuss Proposal (new time)",
"description": "I will call you in 10 minutes.",
"description_html": "<p>I will call you in 10 minutes.</p>",
"date_sent": "2012-02-17T12:53:07-08:00",
"message_id": "",
"message_uid": "",
"reply_to_id": "a028341c-ba92-9343-55e7-56cf5beda121",
"reply_to_status": false,
"total_attachments": 1, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.