id
stringlengths 14
16
| text
stringlengths 33
5.27k
| source
stringlengths 105
270
|
|---|---|---|
6c527aaf235e-1 | Pipeline or Committed are valid values.
Optional
Input Example:
{
'user_id':'seed_max_id,
'timeperiod_id':'36f7085a-5889-ea75-84c8-50f42bd1a5ba',
'display_manager':'false',
'group_by': 'forecast',
'dataset': 'likely',
'ranges': 'include',
}
Output Example:
{ "color" : [ "#8c2b2b",
"#468c2b",
"#2b5d8c",
"#cd5200",
"#e6bf00",
"#7f3acd",
"#00a9b8",
"#572323",
"#004d00", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ExpressionEnginerecordrelated_POST/index.html |
6c527aaf235e-2 | "#572323",
"#004d00",
"#000087",
"#e48d30",
"#9fba09",
"#560066",
"#009f92",
"#b36262",
"#38795c",
"#3D3D99",
"#99623d",
"#998a3d",
"#994e78",
"#3d6899",
"#CC0000",
"#00CC00",
"#0000CC",
"#cc5200",
"#ccaa00",
"#6600cc",
"#005fcc"
],
"label" : [ "Include" ],
"properties" : [ { "gauge_target_list" : "Array", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ExpressionEnginerecordrelated_POST/index.html |
6c527aaf235e-3 | "goal_marker_color" : [ "#000000",
"#7D12B2"
],
"goal_marker_label" : [ "Quota",
"Likely Case"
],
"goal_marker_type" : [ "group",
"pareto"
],
"label_name" : "Include in Forecast",
"labels" : "value",
"legend" : "on",
"print" : "on",
"subtitle" : "",
"thousands" : "",
"title" : null,
"type" : "bar chart",
"value_name" : "Likely Case"
} ],
"values" : [ { "goalmarkervalue" : [ "111000.00", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ExpressionEnginerecordrelated_POST/index.html |
6c527aaf235e-4 | "36000.00"
],
"goalmarkervaluelabel" : [ "$111,000.00",
"$36,000.00"
],
"gvalue" : 36000,
"gvaluelabel" : "$36,000.00",
"label" : "January 2013",
"links" : [ "" ],
"valuelabels" : [ "$36,000.00" ],
"values" : [ 36000 ]
},
{ "goalmarkervalue" : [ "111000.00",
"61500.00"
],
"goalmarkervaluelabel" : [ "$111,000.00",
"$61,500.00"
],
"gvalue" : 25500, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ExpressionEnginerecordrelated_POST/index.html |
6c527aaf235e-5 | ],
"gvalue" : 25500,
"gvaluelabel" : "$25,500.00",
"label" : "February 2013",
"links" : [ "" ],
"valuelabels" : [ "$25,500.00" ],
"values" : [ 25500 ]
},
{ "goalmarkervalue" : [ "111000.00",
"61500.00"
],
"goalmarkervaluelabel" : [ "$111,000.00",
"$61,500.00"
],
"gvalue" : 0,
"gvaluelabel" : "$0.00",
"label" : "March 2013",
"links" : [ "" ],
"valuelabels" : [ "$0.00" ], | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ExpressionEnginerecordrelated_POST/index.html |
6c527aaf235e-6 | "valuelabels" : [ "$0.00" ],
"values" : [ 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/ExpressionEnginerecordrelated_POST/index.html |
1a7f5a93decb-0 | /css/preview GET
Overview
Runs LessPHP for a platform and a theme and outputs the compiled CSS. It only allows to preview the theme because
the file is not saved on the server.
Request Arguments
Name
Type
Description
Required
platform
String
The theme platform - /themes/clients/***PLATFORM***/themeName/. Accepted values are 'base' and 'portal'.
No. (defaults to base)
themeName
String
The theme name - /themes/clients/platform/***THEMENAME***/.
No. (defaults to default)
min
Boolean
Whether or not to minify the css
No. (defaults to false)
Request
{
platform: 'portal',
themeName: 'default',
min: false
}
Response Arguments
Response | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/csspreview_GET/index.html |
1a7f5a93decb-1 | min: false
}
Response Arguments
Response
Content-type: text/css
.someClass {
any-property: any-value;
}
Change Log
Version
Change
v10
Added /css/preview 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/csspreview_GET/index.html |
cde47afd2891-0 | /pmse_Inbox/cancelCases PUT
Overview
Call methods to cancel a process
Summary
This endpoint cancels one or more processes.
Request Arguments
Name
Type
Description
Required
cas_id
array
Collection of process trigger sequence ids
true
Response Arguments
Name
Type
Description
success
boolean
Result of the cancel 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_InboxcancelCases_PUT/index.html |
29393e27191a-0 | /Tags/:record PUT
Overview
Update a record of the specified type.
Request Arguments
Name
Type
Description
Required
<record field>
<record field type>
The name value list of fields to populate.
True
Request
{
"name":"New Account Name",
"phone_office":"(555) 888-5555",
"website":"www.newsite.com",
"meetings": {
{
"add": ["21e3385e-404f-b470-407e-54044e3d8024"],
"delete": ["21e3385e-404f-b470-407e-54044e3d8023"],
"create": [
{
"name": "Test Meeting"
}
] | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Tagsrecord_PUT/index.html |
29393e27191a-1 | {
"name": "Test Meeting"
}
]
}
}
Link fields
It is possible to add or delete record relations to other records and create new related records.
Action
Type
Description
add
List
List of related records ID. See RelateRecordApi
for details.
delete
List
List of related records ID.
create
List
List of name to value arrays of related records.
Response Arguments
Name
Type
Description
<record field>
<record field type>
Returns the fields for the updated record.
Response
{
"id":"f222265a-b755-da89-0bc7-512d09b800b6",
"name":"New Account Name", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Tagsrecord_PUT/index.html |
29393e27191a-2 | "name":"New Account Name",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-27T22:49: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-26T19:12:00+00:00",
"deleted":false,
"assigned_user_id":"seed_sarah_id",
"assigned_user_name":"Sarah Smith",
"team_name":[
{
"id":1,
"name":"Global", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Tagsrecord_PUT/index.html |
29393e27191a-3 | {
"id":1,
"name":"Global",
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"account_type":"Customer",
"industry":"Hospitality",
"annual_revenue":"",
"phone_fax":"",
"billing_address_street":"9 IBM Path",
"billing_address_street_2":"",
"billing_address_street_3":"",
"billing_address_street_4":"",
"billing_address_city":"San Francisco", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Tagsrecord_PUT/index.html |
29393e27191a-4 | "billing_address_city":"San Francisco",
"billing_address_state":"CA",
"billing_address_postalcode":"43635",
"billing_address_country":"USA",
"rating":"",
"phone_office":"(555) 888-5555",
"phone_alternate":"",
"website":"www.newsite.com",
"ownership":"",
"employees":"",
"ticker_symbol":"",
"shipping_address_street":"9 IBM Path",
"shipping_address_street_2":"",
"shipping_address_street_3":"",
"shipping_address_street_4":"",
"shipping_address_city":"San Francisco",
"shipping_address_state":"CA", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Tagsrecord_PUT/index.html |
29393e27191a-5 | "shipping_address_state":"CA",
"shipping_address_postalcode":"43635",
"shipping_address_country":"USA",
"email1":"[email protected]",
"parent_id":"",
"sic_code":"",
"parent_name":"",
"email_opt_out":false,
"invalid_email":false,
"email":[
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"0"
} | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Tagsrecord_PUT/index.html |
29393e27191a-6 | "primary_address":"0"
}
],
"campaign_id":"",
"campaign_name":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
}
Change Log
Version
Change
v10
Added /<module>/:record PUT endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Tagsrecord_PUT/index.html |
4ee30a251c43-0 | /<module>/:record/vcard GET
Overview
Downloads a vCard.
Request Arguments
This endpoint does not accept any arguments.
Response Arguments
Name
Type
Description
<vcard information>
String;
Record in vcard format
Response
BEGIN:VCARD
N;CHARSET=utf-8:Leone;Rosemarie;;
FN;CHARSET=utf-8: Rosemarie Leone
BDAY:
TEL;WORK;FAX:
TEL;HOME;CHARSET=utf-8:(692) 586-8287
TEL;CELL;CHARSET=utf-8:(117) 577-0969
TEL;WORK;CHARSET=utf-8:(844) 325-7679 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordvcard_GET/index.html |
4ee30a251c43-1 | EMAIL;INTERNET;CHARSET=utf-8:[email protected]
ADR;WORK;CHARSET=utf-8:;;777 West Filmore Ln;San Mateo;CA;74984;USA
ORG;CHARSET=utf-8:Q.R.&E. Corp;
TITLE;CHARSET=utf-8:Director Sales
END:VCARD
}
Change Log
Version
Change
v10
Added /<module>/:record/vcard 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/modulerecordvcard_GET/index.html |
aa335ad32a65-0 | /<module>/:record/link/:link_name/:remote_id GET
Overview
Retrieves a related record with relationship role information.
Request Arguments
This endpoint does not accept any arguments.
Response Arguments
Name
Type
Description
<record field>
<record field type>
Returns the fields for the newly created record.
Response
{
"id":"e689173e-c953-1e14-c215-512d0927e7a2",
"name":"Gus Dales",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-26T19:12:00+00:00",
"modified_user_id":"1", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_GET/index.html |
aa335ad32a65-1 | "modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"deleted":false,
"assigned_user_id":"seed_sally_id",
"assigned_user_name":"Sally Bronsen",
"team_name":[
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Gus",
"last_name":"Dales",
"full_name":"Gus Dales",
"title":"Director Operations",
"linkedin":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_GET/index.html |
aa335ad32a65-2 | "title":"Director Operations",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(661) 120-2292",
"email":[
{
"email_address":"[email protected]",
"opt_out":"1",
"invalid_email":"0",
"primary_address":"0"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
}
],
"phone_mobile":"(294) 447-9707", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_GET/index.html |
aa335ad32a65-3 | ],
"phone_mobile":"(294) 447-9707",
"phone_work":"(036) 840-3216",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"primary_address_street":"48920 San Carlos Ave",
"primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Persistance",
"primary_address_state":"CA",
"primary_address_postalcode":"54556",
"primary_address_country":"USA", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_GET/index.html |
aa335ad32a65-4 | "primary_address_country":"USA",
"alt_address_street":"",
"alt_address_street_2":"",
"alt_address_street_3":"",
"alt_address_city":"",
"alt_address_state":"",
"alt_address_postalcode":"",
"alt_address_country":"",
"assistant":"",
"assistant_phone":"",
"picture":"",
"email_and_name1":"",
"lead_source":"Support Portal User Registration",
"account_name":"Arts & Crafts Inc",
"account_id":"d43243c6-9b8e-2973-aee2-512d09bc34b4",
"opportunity_role_fields":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_GET/index.html |
aa335ad32a65-5 | "opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"Technical Advisor",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"GusDales145",
"portal_active":true,
"portal_password":"$1$JxYr6tmM$b.O6.KF42jP46RadSwz0N0",
"portal_password1":"",
"portal_app":"",
"preferred_language":"en_us",
"campaign_id":"",
"campaign_name":"",
"c_accept_status_fields":"",
"m_accept_status_fields":"",
"accept_status_id":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_GET/index.html |
aa335ad32a65-6 | "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 GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_GET/index.html |
43b7647f278d-0 | /TimePeriods/current GET
Get the get the current timeperiod
Summary:
This endpoint is used to get the current TimePeriod. If one is not found a 404 is returned
Output Example:
{
"id":"e394485a-5889-ea75-84c8-51543bd1a5ba",
"name":"Q1 (01\/01\/2013 - 03\/31\/2013)",
"parent_id":"e28efe2d-c51c-be45-3d84-51543b4d2910",
"start_date":"2013-01-01",
"start_date_timestamp":"1356998400",
"end_date":"2013-03-31",
"end_date_timestamp":"1364774399",
"created_by":"1", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriodscurrent_GET/index.html |
43b7647f278d-1 | "created_by":"1",
"date_entered":"2013-03-28 12:46:36",
"date_modified":"2013-03-28 12:46:36",
"deleted":"0",
"is_fiscal":"0",
"is_fiscal_year":"0",
"leaf_cycle":"1",
"type":"Quarter",
"related_timeperiods":""
}
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/TimePeriodscurrent_GET/index.html |
2f644fa6a6f3-0 | /PdfManager 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/PdfManager_GET/index.html |
2f644fa6a6f3-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/PdfManager_GET/index.html |
2f644fa6a6f3-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/PdfManager_GET/index.html |
2f644fa6a6f3-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/PdfManager_GET/index.html |
2f644fa6a6f3-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/PdfManager_GET/index.html |
2f644fa6a6f3-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/PdfManager_GET/index.html |
2f644fa6a6f3-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/PdfManager_GET/index.html |
2f644fa6a6f3-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/PdfManager_GET/index.html |
2f644fa6a6f3-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/PdfManager_GET/index.html |
2f644fa6a6f3-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/PdfManager_GET/index.html |
2f644fa6a6f3-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/PdfManager_GET/index.html |
2f644fa6a6f3-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/PdfManager_GET/index.html |
282e48d758a7-0 | /integrate/<module>/:record_id/:sync_key_field_name/:sync_key_field_value PATCH
Overview
Sets a sync key value for a record.
Request Arguments
Name
Type
Description
Required
module
String
The module the record belongs to
True
record_id
String
The ID of the record whose sync key will be set
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>/:record_id/:sync_key_field_name/:sync_key_field_value
Response | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Integratemodulerecord_idsync_key_field_namesync_key_field_value_PATCH/index.html |
282e48d758a7-1 | Response
{"success": true}
Change Log
Version
Change
v11_10
Added /integrate/<module>/:record_id/:sync_key_field_name/:sync_key_field_value PATCH 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/Integratemodulerecord_idsync_key_field_namesync_key_field_value_PATCH/index.html |
e602d50c49c1-0 | /<module>/customfield POST
Overview
Create a new custom field for a specified module.
Summary
This endpoint is used to create a new custom field for a specified module.
Request Arguments
Name
Type
Description
Required
data
array
The field metadata.
True
Request Examples
This example will create a decimal type custom field:
{
"localizations": {
"en_us": {
"LBL_AI_SCORE": "Ai Score"
},
...
},
"data":{
"name":"ai_score",
"label":"LBL_AI_SCORE",
"type":"decimal",
"len":"18",
"precision":8,
"required":false,
"reportable":false,
"audited":false,
"importable":false, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulecustomfield_POST/index.html |
e602d50c49c1-1 | "audited":false,
"importable":false,
"duplicate_merge":false
}
}
This example will create a textField type custom field:
{
"localizations": {
"en_us": {
"LBL_AI_SCORE_DESC": "Ai Score Description"
},
...
},
"data":{
"name":"ai_score_desc",
"label":"LBL_AI_SCORE_DESC",
"type":"varchar",
"help":"Text Field Help Text",
"comments":"Text Field Comment Text",
"default_value":"",
"len":255,
"required":false,
"reportable":true,
"audited":false,
"importable":"true", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulecustomfield_POST/index.html |
e602d50c49c1-2 | "audited":false,
"importable":"true",
"duplicate_merge":false
}
}
This example will create an enum type custom field with a new dropdown list:
{
"localizations": {
"en_us": {
"LBL_DROPDOWN_FIELD": "New Dropdown Field",
"LBL_DD_ITEM_ONE": "First Text",
"LBL_DD_ITEM_TWO": "Second Text",
"LBL_DD_ITEM_THREE": "Third Text"
},
...
},
"data": {
"name":"new_dropdown_field",
"label":"LBL_DROPDOWN_FIELD",
"type":"enum",
"options": { | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulecustomfield_POST/index.html |
e602d50c49c1-3 | "type":"enum",
"options": {
"dropdownName": "a_new_dropdown",
"dropdownList": [
{"value":"First", "label":"LBL_DD_ITEM_ONE"},
{"value":"Second", "label":"LBL_DD_ITEM_TWO"},
{"value":"Third", "label":"LBL_DD_ITEM_THREE"}
]
},
"default_value":"First"
}
}
This example will create an enum type custom field using an existing dropdown list:
{
"localizations": {
"en_us": {
"LBL_DROPDOWN_FIELD": "New Dropdown Field"
},
...
},
"data": {
"name":"new_dropdown_field", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulecustomfield_POST/index.html |
e602d50c49c1-4 | "data": {
"name":"new_dropdown_field",
"label":"LBL_DROPDOWN_FIELD",
"type":"enum",
"options": "account_type_dom",
"default_value":"Analyst"
}
}
Response
{
"duplicate_merge_dom_value": 0,
"required": false,
"source": "custom_fields",
"name": "ai_score_c",
"vname": "LBL_AI_SCORE",
"type": "decimal",
"massupdate": false,
"hidemassupdate": false,
"no_default": false,
"comments": "",
"help": "",
"importable": "", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulecustomfield_POST/index.html |
e602d50c49c1-5 | "help": "",
"importable": "",
"duplicate_merge": "disabled",
"audited": false,
"reportable": false,
"unified_search": false,
"merge_filter": "disabled",
"pii": false,
"calculated": false,
"len": 18,
"size": "20",
"enable_range_search": false,
"precision": "8",
"id": "ca9653de-0976-11eb-a558-6c400895ea84",
"custom_module": "Opportunities"
}
Change Log
Version
Change
v11.11
Added /<module>/customfield 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/modulecustomfield_POST/index.html |
b90892bf548b-0 | /ProductTemplates/tree GET
ProductTemplate API
Summary:
This endpoint is designed to return a paged recordset of one level of product templates and product categories in
a N-level deep tree representing the relationship between categories and templates. The results are loosely
filtered (wildcard before and after).
Query Parameters:
Param
Description
Optional
filter
The filter used to search Product Template and Product Category names. %filter%
true
root
The ID of the root node you wish to retrieve. Defaults to null (the root level)
true
offset
Specifies the numeric value of the offset you wish to retrieve
true
max_num
Specifies the numeric value of the max number of records you wish to receive. Default is 20.
true
Response Parameters:
Param
Description
id
The id of the item (Product Category/Template)
Data | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ProductTemplatestree_GET/index.html |
b90892bf548b-1 | Description
id
The id of the item (Product Category/Template)
Data
The name of the item
state
Specifies the open or closed state of the element. (used for categories)
index
Specifies the index of this element in the current level.
Response:
{
"records":[
{
"id":"023d316a-d9d0-11e7-9f54-02425392a518",
"type":"category",
"data":"Christen Widgets",
"state":"closed",
"index":0
},
{
"id":"01828a4a-d9d0-11e7-8989-02425392a518",
"type":"category",
"data":"Desktops",
"state":"closed",
"index":1 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ProductTemplatestree_GET/index.html |
b90892bf548b-2 | "state":"closed",
"index":1
}
],
"next_offset":2
}
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/ProductTemplatestree_GET/index.html |
0e8d095e46c5-0 | /pmse_Emails_Templates 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/pmse_Emails_Templates_GET/index.html |
0e8d095e46c5-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/pmse_Emails_Templates_GET/index.html |
0e8d095e46c5-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/pmse_Emails_Templates_GET/index.html |
0e8d095e46c5-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/pmse_Emails_Templates_GET/index.html |
0e8d095e46c5-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/pmse_Emails_Templates_GET/index.html |
0e8d095e46c5-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/pmse_Emails_Templates_GET/index.html |
0e8d095e46c5-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/pmse_Emails_Templates_GET/index.html |
0e8d095e46c5-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/pmse_Emails_Templates_GET/index.html |
0e8d095e46c5-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/pmse_Emails_Templates_GET/index.html |
0e8d095e46c5-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/pmse_Emails_Templates_GET/index.html |
0e8d095e46c5-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/pmse_Emails_Templates_GET/index.html |
0e8d095e46c5-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/pmse_Emails_Templates_GET/index.html |
e4493d69efc4-0 | /oauth2/token POST
Overview
Retrieves the token portion of the OAuth 2.0 specification.
Request Arguments
Name
Type
Description
Required
grant_type
String
Type of request. Available grant types are "password" and "refresh_token".
True
client_id
String
Used to identify the client. A client_id of "sugar" will automatically create an OAuth Key in the system that is used for "password" authentication. A client_id of "support_portal" will create an OAuth Key that will allow for portal authentication. Additional client_id's can be created by the administrator in Admin > OAuth Keys to allow for additional grant types. If the client secret is populated, it will be validated against the client id.
True
client_secret;
String
The clients secret key.
True
username
String | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/oauth2token_POST/index.html |
e4493d69efc4-1 | client_secret;
String
The clients secret key.
True
username
String
The username of the user authenticating to the system.
True
password
String
The plaintext password the user authenticating to the system.
True
platform
String
The platform type. Available types are "base", "mobile", and "portal".
True
Request for Password Grant Types
{
"grant_type":"password",
"client_id":"sugar",
"client_secret":"",
"username":"admin",
"password":"password",
"platform":"base"
}
Request for Refresh Token Grant Types
{
"grant_type":"refresh_token",
"refresh_token":"c1be5132-655b-1ca3-fb44-512e36709871",
"client_id":"sugar", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/oauth2token_POST/index.html |
e4493d69efc4-2 | "client_id":"sugar",
"client_secret":"",
"platform":"base"
}
Response Arguments
Name
Type
Description
access_token
String
The access token needed to authenticate for other methods.
expires_in
Integer
The length of time until access_token expires in seconds.
token_type
String
The token type. Currently only "bearer" is supported.
null|
Â
The Oauth scope. Normally returned as null.
refresh_token
String
The token needed to extend the access_token expiration timeout.
refresh_expires_in
Integer
The length of time until refresh_token expires in seconds.
download_token
String
The token used to download images and files.
Response
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/oauth2token_POST/index.html |
e4493d69efc4-3 | download_token
String
The token used to download images and files.
Response
{
"access_token":"802b64c0-5eac-8431-a541-5342d38ac527",
"expires_in":3600,
"token_type":"bearer",
"scope":null,
"refresh_token":"85053198-24b1-4521-b1a1-5342d382e0b7",
"refresh_expires_in":1209600,
"download_token":"8c9b5461-0d95-8d87-6084-5342d357b39e"
}
Change Log
Version
Change
v10
Added /oauth2/token POST endpoint. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/oauth2token_POST/index.html |
e4493d69efc4-4 | Version
Change
v10
Added /oauth2/token 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/oauth2token_POST/index.html |
57ff265462dd-0 | /lang/labels/dropdown PUT
Overview
Update display labels of dropdown items for dropdowns under different languages.
Summary
This endpoint is used to update display labels of dropdown items in dropdowns under different languages.
Request Arguments
Name
Type
Description
Required
name
string
The dropdown name.
True
labels
array
The new labels grouped by language keys.
True
Request
[
{
"type": "dropdown",
"dropdown": "ai_conv_score_classification_dropdown",
"labels": {
"de_DE": {
"not_likely": "Unwahrscheinlich",
"less_likely": "Weniger wahrscheinlich"
},
"ja_JP": { | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/langlabelsdropdown_PUT/index.html |
57ff265462dd-1 | },
"ja_JP": {
"not_likely": "ããããããªã",
"less_likely": "å¯è½æ§ãä½ã"
}
}
}
]
Â
Response Example
[
{
"name": "ai_conv_score_classification_dropdown",
"labels": {
"de_DE": {
"not_likely": "Unwahrscheinlich",
"less_likely": "Weniger wahrscheinlich"
},
"ja_JP": { | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/langlabelsdropdown_PUT/index.html |
57ff265462dd-2 | },
"ja_JP": {
"not_likely": "ããããããªã",
"less_likely": "å¯è½æ§ãä½ã"
}
}
},
{
"name": "account_type_dom",
"labels": {
"de_DE": {
"Analyst": "Analytiker",
"Competitor": "Wettbewerber"
},
"ja_JP": {
"Analyst": "ã¢ããªã¹ã", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/langlabelsdropdown_PUT/index.html |
57ff265462dd-3 | "Competitor": "競åä»ç¤¾é¸æ"
}
}
}
]
Change Log
Version
Change
v11.13
Added /lang/labels/dropdown/ 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/langlabelsdropdown_PUT/index.html |
79b96fba6124-0 | /<module>/Activities/filter GET
Activities on a module's list view
Summary:
This endpoint lists activities across a particular module in the system. 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/moduleActivitiesfilter_GET/index.html |
79b96fba6124-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/moduleActivitiesfilter_GET/index.html |
79b96fba6124-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/moduleActivitiesfilter_GET/index.html |
5a715d02eddc-0 | /pmse_Inbox/save_notes POST
Overview
Creates a new note for a process
Summary
This endpoint creates a new note for a process
Request Arguments
Name
Type
Description
Required
data
array
Collection of data for a note containing the following:
true
data.cas_id
string
The id of the process trigger sequence
true
data.cas_index
string
The step in the process
true
data.not_content
string
The content of the note
true
data.not_type
string
The type of note, defaults to 'GENERAL'
false
Response Arguments
Name
Type
Description
success
boolean
Result of the update
id
string
Id of new note
date_entered
date
Date of creation
Response
{
"success":true, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxsave_notes_POST/index.html |
5a715d02eddc-1 | date
Date of creation
Response
{
"success":true,
"id":"06c075d0-28e7-11e6-8bb1-6c4008960436",
"date_entered":"2016-06-02T10:25:39-07:00"
}
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_Inboxsave_notes_POST/index.html |
a9aefe508a60-0 | /Leads POST
Create Lead with optional post-save actions
Summary:
This endpoint is used to create a Lead with the optional post-save actions for Convert Target/Prospect and
Create Lead from Email operations.
Query Parameters:
Param
Description
Optional
prospect_id
Pass a prospect id if Lead is being created as part of a Convert Target/Prospect process
Optional
inbound_email_id
Pass an inbound email id if Lead is being created from an Email
Optional
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Leads_POST/index.html |
94b49128fc1b-0 | /Users/:record/link/:link_name/:remote_id POST
Overview
Creates a relationship to a pre-existing record.
Query String Parameters
This endpoint does not accept any arguments.
Response Arguments
Name
Type
Description
record
Array
The record linked to the related record.
related_record
Array
The record that was associated.
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/Usersrecordlinklink_nameremote_id_POST/index.html |
94b49128fc1b-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:21:00+00:00",
"deleted":false,
"assigned_user_id":"seed_max_id",
"assigned_user_name":"Max Jensen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlinklink_nameremote_id_POST/index.html |
94b49128fc1b-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/Usersrecordlinklink_nameremote_id_POST/index.html |
94b49128fc1b-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/Usersrecordlinklink_nameremote_id_POST/index.html |
94b49128fc1b-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/Usersrecordlinklink_nameremote_id_POST/index.html |
94b49128fc1b-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/Usersrecordlinklink_nameremote_id_POST/index.html |
94b49128fc1b-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/Usersrecordlinklink_nameremote_id_POST/index.html |
94b49128fc1b-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/Usersrecordlinklink_nameremote_id_POST/index.html |
94b49128fc1b-8 | "account_name":"Arts & Crafts Inc",
"account_id":"d43243c6-9b8e-2973-aee2-512d09bc34b4",
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"Technical Advisor",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"GusDales145",
"portal_active":true,
"portal_password":"$1$JxYr6tmM$b.O6.KF42jP46RadSwz0N0",
"portal_password1":"",
"portal_app":"",
"preferred_language":"en_us", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlinklink_nameremote_id_POST/index.html |
94b49128fc1b-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 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/Usersrecordlinklink_nameremote_id_POST/index.html |
2b3a65a0f02d-0 | /ConsoleConfiguration/default-metadata GET
Overview
Gets the request metadata in JSON format.
Request Arguments
This endpoint does not accept any request arguments.
URL Parameters
Parameter
Description
Required?
modules
String. Comma-separated module names. Example: 'Accounts,Opportunities'.
Yes
type
String. The type of the desired metadata. The following types are supported: 'filter', 'layout', 'menu', 'view'.
Yes
name
String. The name of the metadata. Examples: 'list', 'record', or 'multi-line-list'.
Yes
URL Example
/rest/v11_9/ConsoleConfiguration/default-metadata?modules=Cases&type=view&name=multi-line-list
Result Arguments
Response
{
"Cases":{
"panels":[
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationdefault-metadata_GET/index.html |
2b3a65a0f02d-1 | {
"Cases":{
"panels":[
{
"label":"LBL_PANEL_1",
"fields":[
{
"name":"case_number",
"label":"LBL_AGENT_WORKBENCH_NUMBER",
"width":"xsmall",
"subfields":[
{
"name":"case_number",
"label":"LBL_AGENT_WORKBENCH_NUMBER",
"default":true,
"enabled":true,
"readonly":true
}
]
},
{
"name":"status",
"label":"LBL_AGENT_WORKBENCH_PRIORITY_STATUS", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationdefault-metadata_GET/index.html |
2b3a65a0f02d-2 | "width":"small",
"subfields":[
{
"name":"priority",
"label":"LBL_LIST_PRIORITY",
"default":true,
"enabled":true,
"type":"enum"
},
{
"name":"status",
"label":"LBL_STATUS",
"default":true,
"enabled":true,
"type":"case-status",
"widget_name":"widget_status"
}
]
},
{
"name":"follow_up_datetime",
"label":"LBL_AGENT_WORKBENCH_FOLLOW_UP",
"width":"medium",
"subfields":[ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationdefault-metadata_GET/index.html |
2b3a65a0f02d-3 | "width":"medium",
"subfields":[
{
"name":"follow_up_datetime",
"label":"LBL_FOLLOW_UP_DATETIME",
"default":true,
"enabled":true,
"readonly":true,
"type":"follow-up-datetime-colorcoded",
"widget_name":"widget_follow_up_datetime",
"color_code_classes":{
"overdue":"expired",
"in_a_day":"soon-expired",
"more_than_a_day":"white black-text"
}
},
{
"name":"follow_up_datetime", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationdefault-metadata_GET/index.html |
2b3a65a0f02d-4 | {
"name":"follow_up_datetime",
"label":"LBL_FOLLOW_UP_DATETIME",
"default":true,
"enabled":true,
"readonly":true,
"type":"datetimecombo"
}
]
},
{
"name":"name",
"label":"LBL_AGENT_WORKBENCH_SUBJECT_DESCRIPTION",
"width":"xlarge",
"subfields":[
{
"name":"name",
"label":"LBL_LIST_SUBJECT",
"link":false,
"default":true,
"enabled":true,
"readonly":true
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationdefault-metadata_GET/index.html |
2b3a65a0f02d-5 | "enabled":true,
"readonly":true
},
{
"name":"description",
"default":true,
"enabled":true,
"readonly":true,
"sortable":false
}
]
},
{
"name":"business_center",
"label":"LBL_BUSINESS_CENTER",
"width":"small",
"subfields":[
{
"name":"business_center_name",
"label":"LBL_BUSINESS_CENTER",
"link":false,
"default":true,
"enabled":true,
"readonly":true
}
]
},
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationdefault-metadata_GET/index.html |
2b3a65a0f02d-6 | }
]
},
{
"name":"account_name",
"label":"LBL_ACCOUNT",
"width":"medium",
"subfields":[
{
"name":"account_name",
"label":"LBL_LIST_ACCOUNT_NAME",
"module":"Accounts",
"id":"ACCOUNT_ID",
"ACLTag":"ACCOUNT",
"related_fields":[
"account_id"
],
"link":false,
"default":true,
"enabled":true
},
{
"name":"service_level",
"label":"LBL_SERVICE_LEVEL",
"type":"enum", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationdefault-metadata_GET/index.html |
2b3a65a0f02d-7 | "type":"enum",
"enum_module":"Accounts",
"link":false,
"default":true,
"enabled":true,
"readonly":true
}
]
},
{
"name":"assigned_user_name",
"label":"LBL_ASSIGNED_TO_NAME",
"width":"small",
"subfields":[
{
"name":"assigned_user_name",
"label":"LBL_ASSIGNED_TO_NAME",
"id":"ASSIGNED_USER_ID",
"link":false,
"default":true,
"enabled":true
}
]
}
] | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationdefault-metadata_GET/index.html |
2b3a65a0f02d-8 | }
]
}
]
}
],
"collectionOptions":{
"limit":100,
"params":{
"max_num":100,
"order_by":"follow_up_datetime",
"nulls_last":true
}
},
"filterDef":[
{
"status":{
"$not_in":[
"Closed",
"Rejected",
"Duplicate"
]
},
"$owner":""
}
]
}
}
Response Codes and Error Messages
All successful responses return 200.
The following error responses are possible: | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationdefault-metadata_GET/index.html |
2b3a65a0f02d-9 | All successful responses return 200.
The following error responses are possible:
403 (SugarAPIExceptionNotAuthorized)Â : Sent if the user attempts to access a module that they are forbidden to access.
422 (SugarApiExceptionInvalidParameter)Â : Sent if the user specifies an invalid type or module.
Change Log
Version
Change
v11.9
Added /ConsoleConfiguration/default-metadata 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/ConsoleConfigurationdefault-metadata_GET/index.html |
079da4b965f6-0 | /<module>/record_list POST
Overview
An API to create and save lists of records.
Summary
Create record list. Only POST request allowed.
Request Arguments
Name
Type
Description
Required
module
string
Module name
True
records
array
Array of records
True
Request Example
POST /rest/v10/:module/record_list
{records: ["e5c8bb3b-5eea-3d8a-c278-56c6affa6212", "e49395b4-d3b0-1e3f-600a-56c6afe7e34f"]}
Response Arguments
Name
Type
Description
id
guid
record list id
assigned_user_id
guid
user id
module_name
string | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_list_POST/index.html |
079da4b965f6-1 | guid
user id
module_name
string
Module name
records
array
record ids
date modified
date
date modified
Output Example
{
"id": "39d2c781-c0b7-446f-1d83-56c6e3cda510",
"assigned_user_id": "1",
"module_name": "Accounts",
"records": [
"e5c8bb3b-5eea-3d8a-c278-56c6affa6212",
"e49395b4-d3b0-1e3f-600a-56c6afe7e34f", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_list_POST/index.html |
079da4b965f6-2 | "c03ed8ee-60d3-c6a6-55c3-56c6af95e696",
"d65573e3-c25a-f9b4-33f2-56c6afb8d856"
],
"date_modified": "2016-02-19 09:42:44"
}
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/modulerecord_list_POST/index.html |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.