id
stringlengths 14
16
| text
stringlengths 33
5.27k
| source
stringlengths 105
270
|
|---|---|---|
fb7fc4008ead-0 | /<module>/enum/:field GET
Overview
Retrieves the enum values for a specific field.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
<list values>
Array
Returns the enum values for a field.
Response
{
"":"",
"Analyst":"Analyst",
"Competitor":"Competitor",
"Customer":"Customer",
"Integrator":"Integrator",
"Investor":"Investor",
"Partner":"Partner",
"Press":"Press",
"Prospect":"Prospect",
"Reseller":"Reseller",
"Other":"Other"
}
Change Log
Version
Change
v10
Added /<module>/enum/:field GET endpoint. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleenumfield_GET/index.html |
fb7fc4008ead-1 | Added /<module>/enum/: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/moduleenumfield_GET/index.html |
4f50927d0601-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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetstimeperiod_iduser_id_GET/index.html |
4f50927d0601-1 | 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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetstimeperiod_iduser_id_GET/index.html |
4f50927d0601-2 | "name": "Grow-Fast Inc - 1000 units",
"date_entered": "2013-02-05T21:22:00+00:00",
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetstimeperiod_iduser_id_GET/index.html |
4f50927d0601-3 | {
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetstimeperiod_iduser_id_GET/index.html |
4f50927d0601-4 | "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 |
6fef73660221-0 | /<module>/:record/next GET
Overview
Retrieves next sibling 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: "e1ae8646-ac90-104a-59d6-5412cf5009b2"
name: "SugarCategoryExample"
date_entered: "2014-09-12 10:47:46"
date_modified: "2014-09-12 10:47:46" | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordnext_GET/index.html |
6fef73660221-1 | date_modified: "2014-09-12 10:47:46"
modified_user_id: "9c9ad14e-1789-3340-f88d-5412cf551d3b"
created_by: "9c9ad14e-1789-3340-f88d-5412cf551d3b"
description: null
deleted: "0"
source_id: null
source_type: null
source_meta: null
root: "e1ae8646-ac90-104a-59d6-5412cf5009b2"
lft: "6"
rgt: "11"
level: "1"
}
Change Log
Version
Change
v10
Added /<module>/:record/next GET endpoint. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordnext_GET/index.html |
6fef73660221-2 | Added /<module>/:record/next 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/modulerecordnext_GET/index.html |
235feeb2b332-0 | /Contact/:record/Cases GET
Overview
Get a contact's related cases, filtered by an expression, which are accessible to a contact with portal visibility.
Summary
This endpoint will return a set of cases filtered by an expression which are accessible to a contact with portal visibility. 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 anAND. 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.
Request
GET /Contact/:id/Cases
Request Arguments
Name
Type
Description
Required
filter
String
See the Filter API for details.
False
filter_id
String | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ContactrecordCases_GET/index.html |
235feeb2b332-1 | filter
String
See the Filter API for details.
False
filter_id
String
Identifier for a pre-existing filter. See the Filter API for details.
False
max_num
Integer
Max number of records that can be returned. Default is 20, unless overruled by your Sugar configuration.
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 field's ID and date_modified will always be returned. For more details on additional field parameters, see the Relate API and Collection API.
False
order_by
String
See the Filter API.
False
deleted
Boolean
Boolean to show deleted records in the result set. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ContactrecordCases_GET/index.html |
235feeb2b332-2 | False
deleted
Boolean
Boolean to show deleted records in the result set.
False
Response
{
"next_offset": -1,
"records": [
{
"id": "d509b3da-29f6-7b23-7cce-56fab1a6335b",
"name": "Need help",
"date_modified": "2016-03-29T09:46:00-07:00",
"_acl": {
"fields": {}
},
"_module": "Cases"
},
{
"id": "cc4982cd-0bdf-bad4-d079-56fab4bdddf1",
"name": "Having trouble", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ContactrecordCases_GET/index.html |
235feeb2b332-3 | "name": "Having trouble",
"date_modified": "2016-03-29T09:57:58-07:00",
"_acl": {
"fields": {}
},
"_module": "Cases"
}
]
}
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.
Change Log
Version
Change
v11
Added /Contact/:record/Cases 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/ContactrecordCases_GET/index.html |
02ed466cfea2-0 | /<module>/insertafter/:target POST
Overview
Insert new node after target node.
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 insert new node after
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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleinsertaftertarget_POST/index.html |
02ed466cfea2-1 | "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, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleinsertaftertarget_POST/index.html |
02ed466cfea2-2 | "lft":118,
"rgt":119,
"level":1,
"_acl":{"fields":{}},
"_module":"Categories"
}
Change Log
Version
Change
v10
Added /<module>/insertafter/: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/moduleinsertaftertarget_POST/index.html |
de106bc16d85-0 | /ForecastWorksheets/filter 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.
Query Parameters:
Param
Description
Optional
filter
What you want to filter on
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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsfilter_GET/index.html |
de106bc16d85-1 | 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
{
"filter":[
{"assigned_user_id" : "seed_jim_id"},
{"timeperiod_id":"e546185a-5889-ea75-84c8-511178d1a5ba"}
],
}
Output Example:
{ "next_offset": -1,
"records": [
{
"id": "ad3908c7-83a3-f360-c223-51117844c208", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsfilter_GET/index.html |
de106bc16d85-2 | "name": "Grow-Fast Inc - 1000 units",
"date_entered": "2013-02-05T21:22:00+00:00",
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsfilter_GET/index.html |
de106bc16d85-3 | {
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsfilter_GET/index.html |
de106bc16d85-4 | "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/ForecastWorksheetsfilter_GET/index.html |
406b27a4fd61-0 | /Administration/elasticsearch/replicas/enable POST
Overview
[ADMIN] Elasticsearch enable replicas
Summary
Enable replicas for all indices managed by SugarCRM. This endpoint is only
available to administrators. This requires reindex_zero_replica to be enabled.
Response
{
"aabbcc_contactsleads": 200,
"aabbcc_accountsonly": 200,
"aabbcc_shared": 200
}
Change Log
Version
Change
v10
Added /Administration/elasticsearch/replicas/enable 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/Administrationelasticsearchreplicasenable_POST/index.html |
891337475ec5-0 | /pmse_Inbox/ReassignForm PUT
Overview
Deprecated endpoint.
Summary
This endpoint is deprecated and will be removed in a future release.
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_InboxReassignForm_PUT/index.html |
a05f19f7fa90-0 | /<module>/sync_key/:sync_key_field_value PUT
Overview
Upserts based on sync_key. If a record can be found with sync_key, then update. If the record does not exist, then create it. Note that the PATCH method is recommended over the PUT method.
Note:Â This endpoint cannot be used to set the sync_key for an existing Sugar record. To do so, it is recommended to use the set sync key endpoint to update the matching Sugar record ID. Once the sync_key is set for the record, then it is possible to leverage this endpoint.
Request Arguments
Name
Type
Description
Required
module
String
The module the record belongs to
True
sync_key_field_value
String
A unique ID for the record identifying it in an external system
True
Request | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulesync_keysync_key_field_value_PUT/index.html |
a05f19f7fa90-1 | String
A unique ID for the record identifying it in an external system
True
Request
/<module>/sync_key/:sync_key_field_value
Response Arguments
Name
Type
Description
record
String
The ID of the record that was upserted.
Response
Status 201: For a created record
Status 200: For an updated record
{ record: "a0328573-a252-a27c-3530-4e4297d4c9e1"}
Change Log
Version
Change
v11_10
Added /<module>/sync_key/:sync_key_field_value 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/modulesync_keysync_key_field_value_PUT/index.html |
78e9156a8969-0 | /pmse_Emails_Templates/:/find_modules GET
Overview
Get the related module list for a module
Summary
This endpoint will retrieve a list of related modules that can be accessed in
the Process Email Templates definition from the specified module. Input
parameters are passed in as the URL query string. Pagination is supported.
Request Arguments
Name
Type
Description
Required
module_list
String
The name of the module the retrieved module list is related to.
True
Request
rest/v11/pmse_Emails_Templates/Quotes/find_modules?module_list=Quotes
Response Arguments
Name
Type
Description
search
String
The value of the input module_list parameter.
success
Boolean
Whether the related module list has been successfully retrieved.
result
Array
An array of related module objects.
Response
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templatesfind_modules_GET/index.html |
78e9156a8969-1 | result
Array
An array of related module objects.
Response
{
"search":"Quotes",
"success":true,
"result":[
{
"value":"Quotes",
"text":"\u003CQuotes\u003E",
"module":"Quotes",
"module_label":"Quotes",
"module_name":"Quotes",
"relationship":"Quotes"
},
{
"value":"billing_accounts",
"text":"Accounts (Bill to Account: billing_accounts)",
"module":"Accounts",
"module_label":"Accounts",
"module_name":"Accounts",
"relationship":"quotes_billto_accounts"
},
{
"value":"shipping_accounts", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templatesfind_modules_GET/index.html |
78e9156a8969-2 | },
{
"value":"shipping_accounts",
"text":"Accounts (Ship to Account: shipping_accounts)",
"module":"Accounts",
"module_label":"Accounts",
"module_name":"Accounts",
"relationship":"quotes_shipto_accounts"
},
{
"value":"billing_contacts",
"text":"Contacts (Bill to Contact: billing_contacts)",
"module":"Contacts",
"module_label":"Contacts",
"module_name":"Contacts",
"relationship":"quotes_contacts_billto"
},
{
"value":"shipping_contacts",
"text":"Contacts (Ship to Contact: shipping_contacts)",
"module":"Contacts", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templatesfind_modules_GET/index.html |
78e9156a8969-3 | "module":"Contacts",
"module_label":"Contacts",
"module_name":"Contacts",
"relationship":"quotes_contacts_shipto"
},
{
"value":"contracts",
"text":"Contracts (Contracts: contracts)",
"module":"Contracts",
"module_label":"Contracts",
"module_name":"Contracts",
"relationship":"contracts_quotes"
},
{
"value":"opportunities",
"text":"Opportunities (Opportunity: opportunities)",
"module":"Opportunities",
"module_label":"Opportunities",
"module_name":"Opportunities",
"relationship":"quotes_opportunities"
},
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templatesfind_modules_GET/index.html |
78e9156a8969-4 | "relationship":"quotes_opportunities"
},
{
"value":"assigned_user_link",
"text":"Users (Assigned to User: assigned_user_link)",
"module":"Users",
"module_label":"Users",
"module_name":"Users",
"relationship":"quotes_assigned_user"
},
{
"value":"created_by_link",
"text":"Users (Created by User: created_by_link)",
"module":"Users",
"module_label":"Users",
"module_name":"Users",
"relationship":"quotes_created_by"
},
{
"value":"modified_user_link",
"text":"Users (Modified by User: modified_user_link)", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templatesfind_modules_GET/index.html |
78e9156a8969-5 | "text":"Users (Modified by User: modified_user_link)",
"module":"Users",
"module_label":"Users",
"module_name":"Users",
"relationship":"quotes_modified_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/pmse_Emails_Templatesfind_modules_GET/index.html |
7e33af74c261-0 | /pmse_Inbox/engine_route PUT
Overview
Evaluates the response of the user form Show Process [Approve, Reject, Route]
Summary
This endpoint handles Approve, Reject and Route actions for a process record.
Request Arguments
Name
Type
Description
Required
frm_action
string
The action to take when it comes to routing the record.
true
Response Arguments
Name
Type
Description
success
boolean
Result of the routing operation
Response
{
"success":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_Inboxengine_route_PUT/index.html |
0820d3a310e8-0 | /ForecastWorksheets/:record PUT
Saves a collection of ForecastWorksheet models
Summary:
This endpoint is used to save the json Data for an array of worksheet data array entries
Query Parameters:
Param
Description
Optional
This endpoint does not accept any parameters.
Input Example:
{ "amount" : "10000.000000",
"assigned_user_id" : "seed_max_id",
"base_rate" : "1",
"best_case" : "25000",
"commit_stage" : "include",
"currency_id" : "-99",
"current_user" : "seed_max_id",
"date_closed" : "2013-01-14",
"date_modified" : "2013-01-14T10:58:27-05:00", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsrecord_PUT/index.html |
0820d3a310e8-1 | "draft" : 1,
"id" : "347beb60-d57c-b3aa-5922-50f42b6c27d4",
"likely_case" : "15000",
"name" : "RR. Talker Co - 1000 units",
"probability" : "90",
"product_id" : "34b0d547-adaf-03ea-146c-50f42b3e6f04",
"sales_stage" : "Value Proposition",
"timeperiod_id" : "36f7085a-5889-ea75-84c8-50f42bd1a5ba",
"version" : 1,
"w_date_modified" : "2013-01-14T10:58:27-05:00", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsrecord_PUT/index.html |
0820d3a310e8-2 | "worksheet_id" : "e0adb532-7d1c-eb49-b102-50f42b455164",
"worst_case" : "10000.000000"
}
Output Example:
{ "amount" : "15000.000000",
"assigned_user_id" : "seed_max_id",
"base_rate" : "1",
"best_case" : "25000.000000",
"commit_stage" : "include",
"currency_id" : "-99",
"date_closed" : "2013-01-14",
"date_modified" : "2013-01-15T10:52:31-05:00", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsrecord_PUT/index.html |
0820d3a310e8-3 | "id" : "347beb60-d57c-b3aa-5922-50f42b6c27d4",
"likely_case" : "15000.000000",
"name" : "RR. Talker Co - 1000 units",
"probability" : "90",
"product_id" : "34b0d547-adaf-03ea-146c-50f42b3e6f04",
"sales_stage" : "Value Proposition",
"version" : 1,
"w_date_modified" : "2013-01-14T10:58:27-05:00",
"worksheet_id" : "e0adb532-7d1c-eb49-b102-50f42b455164", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsrecord_PUT/index.html |
0820d3a310e8-4 | "worst_case" : "10000.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/ForecastWorksheetsrecord_PUT/index.html |
36368092d234-0 | /ForecastManagerWorksheets GET
Returns a collection of ForecastManagerWorksheet models
Summary:
This end point is used to return the ManagerWorksheets 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.
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
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 an administrator, but you are trying to view another managers forecast manager worksheet, you will receive a 403 Not Authorized Error | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheets_GET/index.html |
36368092d234-1 | Url Example:
/rest/v10/ForecastManagerWorksheets/:timeperiod_id/:user_id
Output Example:
{
"next_offset":-1,
"records":[
{
"id":"401594f5-5b46-fb66-1627-55771fe8723e",
"name":"Sally Bronsen",
"date_modified":"2015-06-09T13:13:26-04:00",
"created_by":"1",
"quota":"1932.444445",
"best_case":"29848.000000",
"best_case_adjusted":"37310.000000",
"likely_case":"28694.444445",
"likely_case_adjusted":"35868.055556", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheets_GET/index.html |
36368092d234-2 | "likely_case_adjusted":"35868.055556",
"worst_case":"27540.888889",
"worst_case_adjusted":"34426.111111",
"timeperiod_id":"adb78e81-3fbd-b4e0-287f-55771fd04a06",
"draft":true,
"is_manager":false,
"user_id":"seed_sally_id",
"opp_count":10,
"pipeline_opp_count":3,
"pipeline_amount":"2415.555556",
"closed_amount":"26278.888889",
"manager_saved":true,
"show_history_log":0,
"following":false, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheets_GET/index.html |
36368092d234-3 | "show_history_log":0,
"following":false,
"assigned_user_id":"seed_sarah_id",
"assigned_user_name":"Sarah Smith",
"team_name":[
{
"id":"1",
"name":"Global",
"name_2":"",
"primary":true
}
],
"currency_id":"-99",
"base_rate":"1.000000",
"_acl":{
"fields":{
}
},
"_module":"ForecastManagerWorksheets"
},
{
"id":"28226f12-a3c9-bd84-041e-55771f064c4e",
"name":"Max Jensen", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheets_GET/index.html |
36368092d234-4 | "name":"Max Jensen",
"date_modified":"2015-06-09T13:13:26-04:00",
"created_by":"1",
"quota":"3141.333332",
"best_case":"15848.222223",
"best_case_adjusted":"13206.851853",
"likely_case":"14928.222222",
"likely_case_adjusted":"12440.185185",
"worst_case":"14008.222223",
"worst_case_adjusted":"11673.518519",
"timeperiod_id":"adb78e81-3fbd-b4e0-287f-55771fd04a06",
"draft":true,
"is_manager":false, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheets_GET/index.html |
36368092d234-5 | "draft":true,
"is_manager":false,
"user_id":"seed_max_id",
"opp_count":12,
"pipeline_opp_count":3,
"pipeline_amount":"2617.777777",
"closed_amount":"12310.444445",
"manager_saved":true,
"show_history_log":0,
"following":false,
"assigned_user_id":"seed_sarah_id",
"assigned_user_name":"Sarah Smith",
"team_name":[
{
"id":"1",
"name":"Global",
"name_2":"",
"primary":true
}
],
"currency_id":"-99", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheets_GET/index.html |
36368092d234-6 | }
],
"currency_id":"-99",
"base_rate":"1.000000",
"_acl":{
"fields":{
}
},
"_module":"ForecastManagerWorksheets"
},
{
"id":"1aca66af-f069-bba4-28a1-55771fe27506",
"name":"",
"date_modified":"2015-06-09T13:13:26-04:00",
"created_by":"1",
"quota":"10142.333333",
"best_case":"37625.000000",
"best_case_adjusted":"37625.000000",
"likely_case":"34241.333333",
"likely_case_adjusted":"34241.333333", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheets_GET/index.html |
36368092d234-7 | "likely_case_adjusted":"34241.333333",
"worst_case":"30857.666667",
"worst_case_adjusted":"30857.666667",
"timeperiod_id":"adb78e81-3fbd-b4e0-287f-55771fd04a06",
"draft":true,
"is_manager":true,
"user_id":"seed_sarah_id",
"opp_count":13,
"pipeline_opp_count":6,
"pipeline_amount":"10142.333333",
"closed_amount":"24099.000000",
"manager_saved":true,
"show_history_log":0,
"following":false, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheets_GET/index.html |
36368092d234-8 | "show_history_log":0,
"following":false,
"assigned_user_id":"seed_sarah_id",
"assigned_user_name":"Sarah Smith",
"team_name":[
{
"id":"1",
"name":"Global",
"name_2":"",
"primary":true
}
],
"currency_id":"-99",
"base_rate":"1.000000",
"_acl":{
"fields":{
}
},
"_module":"ForecastManagerWorksheets"
}
]
}
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/ForecastManagerWorksheets_GET/index.html |
f73efd05b1a7-0 | /Dashboards/Activities GET
Overview
List current user's filtered Activity Stream dashboards.
Summary
This endpoint will return a set of Activity Stream dashboards 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.
Notice
The behavior of this endpoint has changed in v11. 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: | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/DashboardsActivities_GET/index.html |
f73efd05b1a7-1 | For more information on behavior in v11, refer to GET /<module>.
Recommended Replacement:
GET /Dashboards
The module name is no longer part of the path. To specify a module name, include it as a filter
parameter, usev11:
GET /Dashboards?filter[0][dashboard_module]=Activities
name, id. etc. are no longer specified as default fields. To retain the default fields, usev11:
GET /Dashboards?filter[0][dashboard_module]=Activities&fields=id,name,view_name
Request Arguments
Name
Type
Description
Required
filter
String
See Filter API.
False
filter_id
String
Identifier for a preexisting filter. See
the Filter API for details.
False
max_num
Integer | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/DashboardsActivities_GET/index.html |
f73efd05b1a7-2 | the Filter API for details.
False
max_num
Integer
Max number of records that can be returned. Default is 20, unless overruled by your Sugar configuration.
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.
For more details on additional field parameters, see
Relate API and
Collection API.
False
order_by
String
See Filter API.
False
deleted
Boolean
Boolean to show deleted records in the result set.
False
Response Arguments
Name
Type
Description | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/DashboardsActivities_GET/index.html |
f73efd05b1a7-3 | 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
{
"next_offset": -1,
"records": [
{
"id": "d509b3da-29f6-7b23-7cce-56fab1a6335b",
"name": "Activity Stream Dashboard",
"date_modified": "2016-03-29T09:46:00-07:00",
"view_name": "activities",
"_acl": {
"fields": {}
},
"view": "activities",
"_module": "Dashboards"
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/DashboardsActivities_GET/index.html |
f73efd05b1a7-4 | "_module": "Dashboards"
},
{
"id": "cc4982cd-0bdf-bad4-d079-56fab4bdddf1",
"name": "Activity Stream Dashboard 2",
"date_modified": "2016-03-29T09:57:58-07:00",
"view_name": "activities",
"_acl": {
"fields": {}
},
"view": "activities",
"_module": "Dashboards"
}
]
}
Change Log
Version
Change
v11
No longer supported. Please use GET /Dashboards instead.
v10
Added /Dashboards/Activities 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/DashboardsActivities_GET/index.html |
fa56df39fd15-0 | /TimePeriods/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/TimePeriodsfilter_GET/index.html |
fa56df39fd15-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/TimePeriodsfilter_GET/index.html |
fa56df39fd15-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/TimePeriodsfilter_GET/index.html |
fa56df39fd15-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/TimePeriodsfilter_GET/index.html |
fa56df39fd15-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/TimePeriodsfilter_GET/index.html |
fa56df39fd15-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/TimePeriodsfilter_GET/index.html |
fa56df39fd15-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/TimePeriodsfilter_GET/index.html |
fa56df39fd15-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/TimePeriodsfilter_GET/index.html |
fa56df39fd15-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/TimePeriodsfilter_GET/index.html |
fa56df39fd15-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/TimePeriodsfilter_GET/index.html |
fa56df39fd15-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/TimePeriodsfilter_GET/index.html |
fa56df39fd15-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/TimePeriodsfilter_GET/index.html |
7f8b9d507502-0 | /Administration/search/fields GET
Overview
[ADMIN] Search field configuration
Summary
This endpoint lists the full text search configuration of all fields for the full text search enabled modules. This
endpoint is only available to administrators.
Request Arguments
Name
Type
Description
Required
module_list
String
Comma delimited list of modules to return. If omitted, all search enabled modules will be returned.
Example: Accounts,Contacts
False
search_only
Boolean
When set, only searchable fields are returned. Defaults to false.
False
order_by_boost
Boolean
When set, a flat list of searchable fields is returned ordered by boost value.
False
Response
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationsearchfields_GET/index.html |
7f8b9d507502-1 | False
Response
{
"Accounts":{
"name":{
"name":"name",
"type":"name",
"searchable":true,
"boost":1
},
"date_modified":{
"name":"date_modified",
"type":"datetime",
"searchable":false
}
}
}
Response using order_by_boost
{
"Quotes.quote_num":1.5,
"Manufacturers.name":1,
"Bugs.name":0.9,
"ProjectTask.name":0.5,
}
Change Log
Version
Change
v10
Added /Administration/search/fields 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/Administrationsearchfields_GET/index.html |
076dd3a1fea2-0 | /Leads/:leadId/convert POST
Convert Lead to a Contact and optionally link it to a new or existing instance of the modules specified
Summary:
This endpoint is used to convert the specified Lead to a Contact and optionally link that Contact to a new or existing instance of the modules specified.
The types of modules that can be specified are limited to those that have been configured by the system administrator.
Post Parameters:
Parameter
Description
modules (required)
An object containing the Contacts module to be created as part of the conversion, along with (optionally)
any modules that this new Contact record is to be related to. If relate-to modules are also specified, they must
consist of a valid module type and either the id of a existing module of that type, or if new, the full record | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/LeadsleadIdconvert_POST/index.html |
076dd3a1fea2-1 | to be created for that type. Note that the allowed module types are defined by the System Administrator.
 Example
{
"modules": {
"Contacts": {
"deleted": "0",
"do_not_call": false,
"portal_active": "0",
"preferred_language": "en_us",
"assigned_user_id": "1",
"assigned_user_name": "Administrator",
"salutation": "",
"first_name": "Darius",
"last_name": "Paisley",
"title": "Director Operations",
"department": "",
"description": "",
"team_name": [
{
"id": "East",
"name": "East", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/LeadsleadIdconvert_POST/index.html |
076dd3a1fea2-2 | {
"id": "East",
"name": "East",
"name_2": "",
"primary": true
},
{
"id": 1,
"name": "Global",
"name_2": "",
"primary": false
},
{
"id": "West",
"name": "West",
"name_2": "",
"primary": false
}
],
"phone_home": "(890) 241-5509",
"phone_mobile": "(738) 338-2546",
"phone_work": "(579) 448-8879",
"phone_fax": "",
"primary_address_street": "123 Anywhere Street",
"primary_address_city": "Salt Lake City", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/LeadsleadIdconvert_POST/index.html |
076dd3a1fea2-3 | "primary_address_city": "Salt Lake City",
"primary_address_state": "CA",
"primary_address_postalcode": "81738",
"primary_address_country": "USA",
"campaign_id": "",
"campaign_name": "",
"email": [
{
"email_address": "[email protected]",
"invalid_email": false,
"opt_out": false,
"primary_address": true,
"reply_to_address": false
}
]
},
"Accounts": {
"id": "1c212ff9-c0d5-866d-d3ae-526e6cd47a31",
"name": "Lexington Shores Corp", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/LeadsleadIdconvert_POST/index.html |
076dd3a1fea2-4 | "name": "Lexington Shores Corp",
"date_entered": "2013-10-28T09:52:46-04:00",
"date_modified": "2013-10-28T09:52:46-04:00",
"modified_user_id": "1",
"modified_by_name": "Administrator",
"created_by": "1",
"created_by_name": "Administrator",
"description": "",
"deleted": false,
"assigned_user_id": "seed_sally_id",
"assigned_user_name": "Sally Bronsen",
"team_count": "",
"team_name": [
{
"id": "West",
"name": "West", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/LeadsleadIdconvert_POST/index.html |
076dd3a1fea2-5 | {
"id": "West",
"name": "West",
"name_2": "",
"primary": true
}
],
"linkedin": "",
"facebook": "",
"twitter": "",
"googleplus": "",
"account_type": "Customer",
"industry": "Electronics",
"annual_revenue": "",
"phone_fax": "",
"billing_address_street": "111 Silicon Valley Road",
"billing_address_street_2": "",
"billing_address_street_3": "",
"billing_address_street_4": "",
"billing_address_city": "Santa Fe",
"billing_address_state": "CA", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/LeadsleadIdconvert_POST/index.html |
076dd3a1fea2-6 | "billing_address_state": "CA",
"billing_address_postalcode": "63785",
"billing_address_country": "USA",
"rating": "",
"phone_office": "(641) 347-6902",
"phone_alternate": "",
"website": "www.imphone.de",
"ownership": "",
"employees": "",
"ticker_symbol": "",
"shipping_address_street": "111 Silicon Valley Road",
"shipping_address_street_2": "",
"shipping_address_street_3": "",
"shipping_address_street_4": "",
"shipping_address_city": "Santa Fe", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/LeadsleadIdconvert_POST/index.html |
076dd3a1fea2-7 | "shipping_address_city": "Santa Fe",
"shipping_address_state": "CA",
"shipping_address_postalcode": "63785",
"shipping_address_country": "USA",
"email": [
{
"email_address": "[email protected]",
"invalid_email": false,
"opt_out": false,
"primary_address": true,
"reply_to_address": false
},
{
"email_address": "[email protected]",
"invalid_email": false,
"opt_out": false,
"primary_address": false,
"reply_to_address": false
}
], | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/LeadsleadIdconvert_POST/index.html |
076dd3a1fea2-8 | "reply_to_address": false
}
],
"email1": "[email protected]",
"parent_id": "",
"sic_code": "",
"parent_name": "",
"email_opt_out": false,
"invalid_email": false,
"campaign_id": "",
"campaign_name": "",
"my_favorite": false,
"_acl": {
"fields": {}
},
"following": false,
"_module": "Accounts",
"duplicate_check_rank": 8
},
"Opportunities": {
"id": "5529e246-c42f-04e0-1989-526e6d3029c6", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/LeadsleadIdconvert_POST/index.html |
076dd3a1fea2-9 | "name": "Lexington Shores Corp - 311 Units",
"date_entered": "2013-10-28T09:52:46-04:00",
"date_modified": "2013-10-28T09:52:46-04:00",
"modified_user_id": "1",
"modified_by_name": "Administrator",
"created_by": "1",
"created_by_name": "Administrator",
"description": "",
"deleted": false,
"assigned_user_id": "seed_sally_id",
"assigned_user_name": "Sally Bronsen",
"team_count": "",
"team_name": [
{
"id": "West",
"name": "West", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/LeadsleadIdconvert_POST/index.html |
076dd3a1fea2-10 | {
"id": "West",
"name": "West",
"name_2": "",
"primary": true
}
],
"opportunity_type": "",
"account_name": "Lexington Shores Corp",
"account_id": "1c212ff9-c0d5-866d-d3ae-526e6cd47a31",
"campaign_id": "",
"campaign_name": "",
"lead_source": "Partner",
"amount": 10413,
"base_rate": 1,
"amount_usdollar": 10413,
"currency_id": "-99",
"currency_name": "",
"currency_symbol": "",
"date_closed": "2014-03-30", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/LeadsleadIdconvert_POST/index.html |
076dd3a1fea2-11 | "date_closed": "2014-03-30",
"date_closed_timestamp": 1396187804,
"next_step": "",
"sales_stage": "Prospecting",
"sales_status": "New",
"probability": 10,
"best_case": 11795,
"worst_case": 9031,
"commit_stage": "exclude",
"total_revenue_line_items": 5,
"closed_revenue_line_items": 1,
"contact_role": "",
"my_favorite": false,
"_acl": {
"fields": {}
},
"following": false,
"_module": "Opportunities",
"duplicate_check_rank": 0
}
} | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/LeadsleadIdconvert_POST/index.html |
076dd3a1fea2-12 | "duplicate_check_rank": 0
}
}
}
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/LeadsleadIdconvert_POST/index.html |
d94b3d72deb4-0 | /Mail/archive POST
Overview
Archives an email.
Query String Parameters
This endpoint does not accept any query string parameters.
Input Parameters
Name
Type
Description
Required
date_sent
String
Date of email sent
True
from_address
String
From email address
True
to_addresses
Array
Array of name/email address pairs for the TO field, when present, only email subfield is required (not name).
True
cc_addresses
Array
Array of name/email address pairs for the CC field, when present, email subfield is required.
False
bcc_addresses
Array | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailarchive_POST/index.html |
d94b3d72deb4-1 | False
bcc_addresses
Array
Array of name/email address pairs for the BCC field, when present, email subfield is required.
False
subject
String
Subject of the email
True
html_body
String
HTML body of the email
False
text_body
String
Text body of the email
False
status
String
Indicates the status of the email - 'draft' or 'ready' (ready to be sent)
True
related
Object | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailarchive_POST/index.html |
d94b3d72deb4-2 | True
related
Object
Contains 'parent_type' and 'parent_id' to relate this email to (for example 'Contact' and a contact's id)
False
teams
Object
Team(s) to assign this email to. 'primary' attribute is an id string for the primary team and 'other' attribute is an array of id strings for the other teams - only primary is required
True
assigned_user_id
String
ID of a user this record is assigned to.
False
attachments
Array | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailarchive_POST/index.html |
d94b3d72deb4-3 | False
attachments
Array
Array of file attachments - each attachment consists of a 'type' (where the attachment came from: upload, document, or template), 'id' (of the file upload, note, document revision, etc), and 'name' (the file name)
False
Input Example
{
"date_sent":"2014-02-07T00:00:00",
"from_address":"[email protected]"
"to_addresses":[
{
"name":"John Doe",
"email":"[email protected]",
"module":"Leads"
},
{
"name":"David Madison",
"email":"[email protected]",
"module":"Leads"
}
], | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailarchive_POST/index.html |
d94b3d72deb4-4 | "module":"Leads"
}
],
"cc_addresses":[
{
"name":"Tom Swift",
"email":"[email protected]"
}
],
"bcc_addresses":null,
"subject":"Minneapolis Convention",
"html_body":"<html><body>Hello World<\/body><\/html>",
"text_body":"Hello World"
"status":"archive",
"related": {
"type":"Contacts",
"id":"61cf0f8d-938c-c9b2-53ad-51ed7bbcf83b"
},
"teams": {
"primary": "dabec868-696c-f458-e204-50227995ab50", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailarchive_POST/index.html |
d94b3d72deb4-5 | "others": [
"c3094c88-c95f-2e17-4553-50227996ad20",
"abcde868-696c-f458-e704-58369095ab62"
]
},
"assigned_user_id":"seed_jim_id",
"attachments": [
{
"type": "upload",
"id": "cfbe4551-548d-f602-b228-45387645fc12",
"name": "company_logo.jpg"
},
{
"type": "document",
"id": "876112a4-89c1-4ba7-a05a-7729a7a76818"
},
{
"type": "template", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailarchive_POST/index.html |
d94b3d72deb4-6 | },
{
"type": "template",
"id": "002cfe6c-98e9-4342-bdb1-1660d0788872"
}
],
}
Result
Name
Type
Description
<email record field>
<email record field type>
Returns the fields for the newly created email record.
Output Example
{
"team_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
"team_set_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
"id": "d9c165d0-8863-ba61-dc85-51ed8016c476", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailarchive_POST/index.html |
d94b3d72deb4-7 | "date_entered": "2013-07-22 18:57:57",
"date_modified": "2013-07-22 18:57:57",
"assigned_user_id": "1",
"assigned_user_name": "",
"modified_user_id": "1",
"modified_by_name": "admin",
"created_by": "1",
"created_by_name": "",
"deleted": 0,
"from_addr_name": "SugarCRM",
"reply_to_addr": "",
"to_addrs_names": "[email protected], [email protected]",
"cc_addrs_names": "[email protected]", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailarchive_POST/index.html |
d94b3d72deb4-8 | "cc_addrs_names": "[email protected]",
"description_html": "<html><body>Hello World<\/body><\/html>",
"description": "Hello World",
"date_sent": "2013-07-22 18:57:00",
"name": "Minneapolis Convention",
"type": "out",
"status": "sent",
"parent_type": "Contacts",
"parent_id": "61cf0f8d-938c-c9b2-53ad-51ed7bbcf83b",
"from_address":"[email protected]"
}
Change Log
Version
Change
v11
Last version in which /Mail/archive POST is available. Use /Emails POST with | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailarchive_POST/index.html |
d94b3d72deb4-9 | Last version in which /Mail/archive POST is available. Use /Emails POST with
{"state": "Archived"} instead.
v10
Added /Mail/archive 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/Mailarchive_POST/index.html |
fe8b44d199af-0 | /Emails/filter/count 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/Emailsfiltercount_GET/index.html |
fe8b44d199af-1 | Name
Type
Description
Required
filter
String
The filter expression. Filter expressions are explained below.
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
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.
Example: name,account_type,description
False | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html |
fe8b44d199af-2 | 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
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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html |
fe8b44d199af-3 | 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. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html |
fe8b44d199af-4 | $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.
$is_null | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html |
fe8b44d199af-5 | $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. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html |
fe8b44d199af-6 | 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":[
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html |
fe8b44d199af-7 | Example
{
"filter":[
{
"$favorite":"_this"
}
]
}
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
{
"next_offset":-1,
"records":[
{
"id":"fa300a0e-0ad1-b322-9601-512d0983c19a",
"name":"Dale Spivey",
"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/Emailsfiltercount_GET/index.html |
fe8b44d199af-8 | "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
},
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html |
fe8b44d199af-9 | "name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"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]", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html |
fe8b44d199af-10 | "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.", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.