id
stringlengths 14
16
| text
stringlengths 33
5.27k
| source
stringlengths 105
270
|
|---|---|---|
fe8b44d199af-11 | "primary_address_street":"345 Sugar Blvd.",
"primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Denver",
"primary_address_state":"CA",
"primary_address_postalcode":"87261",
"primary_address_country":"USA",
"alt_address_street":"",
"alt_address_street_2":"",
"alt_address_street_3":"",
"alt_address_city":"",
"alt_address_state":"",
"alt_address_postalcode":"",
"alt_address_country":"",
"assistant":"",
"assistant_phone":"",
"picture":"",
"email_and_name1":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html |
fe8b44d199af-12 | "picture":"",
"email_and_name1":"",
"lead_source":"Campaign",
"account_name":"Smallville Resources Inc",
"account_id":"d5db6292-5c24-eb61-e202-512d09f0134e",
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"DaleSpivey97",
"portal_active":true,
"portal_password":"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\/",
"portal_password1":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html |
fe8b44d199af-13 | "portal_password1":"",
"portal_app":"",
"preferred_language":"en_us",
"campaign_id":"",
"campaign_name":"",
"c_accept_status_fields":"",
"m_accept_status_fields":"",
"accept_status_id":"",
"accept_status_name":"",
"sync_contact":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
},
{
"id":"95e17367-9b3d-0e26-22dc-512d0961fedf",
"name":"Florence Haddock",
"date_entered":"2013-02-26T19:12:00+00:00", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html |
fe8b44d199af-14 | "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":"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-15 | "name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Florence",
"last_name":"Haddock",
"full_name":"Florence Haddock",
"title":"Director Sales",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(729) 845-3137",
"email":[
{
"email_address":"[email protected]",
"opt_out":"1", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html |
fe8b44d199af-16 | "opt_out":"1",
"invalid_email":"0",
"primary_address":"0"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
}
],
"phone_mobile":"(246) 233-1382",
"phone_work":"(565) 696-6981",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"primary_address_street":"111 Silicon Valley Road", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html |
fe8b44d199af-17 | "primary_address_street":"111 Silicon Valley Road",
"primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Denver",
"primary_address_state":"CA",
"primary_address_postalcode":"79900",
"primary_address_country":"USA",
"alt_address_street":"",
"alt_address_street_2":"",
"alt_address_street_3":"",
"alt_address_city":"",
"alt_address_state":"",
"alt_address_postalcode":"",
"alt_address_country":"",
"assistant":"",
"assistant_phone":"",
"picture":"",
"email_and_name1":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html |
fe8b44d199af-18 | "picture":"",
"email_and_name1":"",
"lead_source":"Support Portal User Registration",
"account_name":"Smallville Resources Inc",
"account_id":"d5db6292-5c24-eb61-e202-512d09f0134e",
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"FlorenceHaddock169",
"portal_active":true,
"portal_password":"$1$nWFhTbK6$JF9BCGSqL\/NCrbhueX5ia0",
"portal_password1":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html |
fe8b44d199af-19 | "portal_password1":"",
"portal_app":"",
"preferred_language":"en_us",
"campaign_id":"",
"campaign_name":"",
"c_accept_status_fields":"",
"m_accept_status_fields":"",
"accept_status_id":"",
"accept_status_name":"",
"sync_contact":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
}
]
}
Change Log
Version
Change
v10
Added /<module>/filter 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/Emailsfiltercount_GET/index.html |
d9363483ba09-0 | /integrate/<module>/:sync_key_field_name/:sync_key_field_value PATCH
Overview
Upserts based on sync_key_field_name. If a record can be found with sync_key_field_name, then update. If the record does not exist, then create it.
Note:Â This endpoint cannot be used to set the sync_key_field_name 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_name
String | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Integratemodulesync_key_field_namesync_key_field_value_PATCH/index.html |
d9363483ba09-1 | The module the record belongs to
True
sync_key_field_name
String
The name of the field that contains sync_key_field_value (the default field is named sync_key but can be renamed via code customization)
True
sync_key_field_value
String
A unique ID for the record identifying it in an external system
True
Request
/integrate/<module>/:sync_key_field_name/:sync_key_field_value
Response Arguments
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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Integratemodulesync_key_field_namesync_key_field_value_PATCH/index.html |
d9363483ba09-2 | Change Log
Version
Change
v11_10
Added /integrate/<module>/: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/Integratemodulesync_key_field_namesync_key_field_value_PATCH/index.html |
57f5c092e107-0 | /Administration/idm/migration/enable POST
Overview
[ADMIN] Enable Idm migrations
Summary
This endpoint enables Idm migrations. This endpoint is only available to administrators.
Request Arguments
This endpoint does not accept any arguments.
Response
{
"success": true
}
Change Log
Version
Change
v11_2
Added Administration/idm/migration/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/Administrationidmmigrationenable_POST/index.html |
acb3f102ec26-0 | /KBContents 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/KBContents_GET/index.html |
acb3f102ec26-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/KBContents_GET/index.html |
acb3f102ec26-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/KBContents_GET/index.html |
acb3f102ec26-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/KBContents_GET/index.html |
acb3f102ec26-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/KBContents_GET/index.html |
acb3f102ec26-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/KBContents_GET/index.html |
acb3f102ec26-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/KBContents_GET/index.html |
acb3f102ec26-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/KBContents_GET/index.html |
acb3f102ec26-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/KBContents_GET/index.html |
acb3f102ec26-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/KBContents_GET/index.html |
acb3f102ec26-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/KBContents_GET/index.html |
acb3f102ec26-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/KBContents_GET/index.html |
6e4194fd4e3b-0 | /pmse_Project/file/project_import POST
Overview
Imports a Process Definition from a .bpm file
Summary
This endpoint will import a Process Definition from the uploaded .bpm file
containing JSON encoded data.
Request Arguments
Name
Type
Description
Required
selectedIds
array
A list of IDs for dependent elements to import.
False
Request
Note: A JSON encoded .bpm file attachment should be included with
the request as part of the form-data. An optional array of IDs can be included to indicate
which dependent Business Rules and Email Templates to import and link with the Process Definition.
The file must contain the metadata for the dependent elements as well for the selectedIds to be used.
Important: The request format must be multipart/form-data.
Response Arguments
Name
Type
Description
project_import
Object
Result of the import operation
Response | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectfileproject_import_POST/index.html |
6e4194fd4e3b-1 | Name
Type
Description
project_import
Object
Result of the import operation
Response
{
"project_import":
{
"success":true,
"id":"459f05de-3c3a-c0e7-ce1e-573cabe79e7c",
"br_warning":true,
"et_warning":true
}
}
Compatibility
SugarBPMTM files exported from Sugar version 7.6.1.0 or earlier cannot be imported to Sugar instances running 7.6.2.0 or later.
Change Log
Version
Change
v11_2
Added support for selectedIds to specify which dependent elements to import.
v10
Added /pmse_Project/file/project_import POST endpoint. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectfileproject_import_POST/index.html |
6e4194fd4e3b-2 | Added /pmse_Project/file/project_import 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/pmse_Projectfileproject_import_POST/index.html |
2be34cc1c379-0 | /pmse_Project/EventDefinition/:record PUT
Overview
Updates the definition data for an event
Summary
This endpoint will update the Process Definition event identified by the
record input parameter with the data provided in the request
payload.
Request Arguments
Name
Type
Description
Required
record
String
The value for the evn_uid field in the pmse_bpmn_event record
True
Request Payload
There are 5 event types in SugarBPMTM.
Start Event
{
"data":
{
"evn_module":"Accounts",
"evn_params":"updated",
"evn_criteria":null
}
}
Timer Event
{
"data":
{
"evn_timer_type":"duration",
"evn_duration_criteria":"10", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectEventDefinitionrecord_PUT/index.html |
2be34cc1c379-1 | "evn_duration_criteria":"10",
"evn_duration_params":"minute",
"evn_criteria":null
}
}
Receive Message Event
{
"data":
{
"evn_criteria":[
{
"expType":"MODULE",
"expSubtype":"DropDown",
"expLabel":"Accounts (Industry is equal to Banking)",
"expValue":"Banking",
"expOperator":"equals",
"expModule":"Accounts",
"expField":"industry"
}
]
}
}
Send Message Event
{
"data":
{
"evn_module":"Accounts", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectEventDefinitionrecord_PUT/index.html |
2be34cc1c379-2 | "data":
{
"evn_module":"Accounts",
"evn_criteria":"8444baae-c73f-11e8-afa5-6c400895ea84",
"evn_params":
{
"to":[
{
"type":"recipient",
"module":"calls",
"moduleLabel":"Calls",
"value":"email1",
"label":"%MODULE% : Email Address",
"filter":{
"expType":"MODULE",
"expSubtype":"DropDown",
"expLabel":"Calls (Status is equal to Scheduled)",
"expValue":"Planned",
"expOperator":"equals",
"expModule":"calls",
"expField":"status"
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectEventDefinitionrecord_PUT/index.html |
2be34cc1c379-3 | "expModule":"calls",
"expField":"status"
},
"chainedRelationship":{
"module":"contact_parent",
"moduleLabel":"Contacts",
"filter":{
"expType":"MODULE",
"expSubtype":"DropDown",
"expLabel":"Contacts (Lead Source is equal to Cold Call)",
"expValue":"Cold Call",
"expOperator":"equals",
"expModule":"contact_parent",
"expField":"lead_source"
}
}
}
],
"cc":[],
"bcc":[]
}
}
}
End Event
{
"data":{
"activities":{
},
"events":{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectEventDefinitionrecord_PUT/index.html |
2be34cc1c379-4 | "activities":{
},
"events":{
"4849630305bb7e68ae078d5012588603":{
"evn_uid":"4849630305bb7e68ae078d5012588603",
"evn_behavior":"THROW",
"evn_marker":"EMPTY",
"evn_message":"",
"action":"UPDATE"
}
},
"gateways":{
},
"flows":{
},
"artifacts":{
},
"prj_uid":"389d3d5a-c8ee-11e8-bc27-6c400895ea84"
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectEventDefinitionrecord_PUT/index.html |
2be34cc1c379-5 | },
"id":"389d3d5a-c8ee-11e8-bc27-6c400895ea84",
"operation":"update",
"wrapper":"Project"
}
Response Arguments
Name
Type
Description
N/A
Response
null
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectEventDefinitionrecord_PUT/index.html |
38c6c98c9919-0 | /Administration/license/limits GET
Overview
[ADMIN] Get License Limits.
Summary
This endpoint gets the license limits, the number of unused licensed seats for each license type. This endpoint is only available to administrators.
Request Arguments
This endpoint does not accept any arguments.
Response
{
"default_limit": 100,
"limit_enforced": 1,
"default_license_type" : "CURRENT",
"seats": {
"CURRENT": 100,
"SUGAR_SERVE": 10
},
"available_seats": {
"CURRENT": 25,
"SUGAR_SERVE": 1,
"SUGAR_SELL": 0
}
}
Change Log
Version
Change
v11_2
Added /Administration/license/limits GET endpoint. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationlicenselimits_GET/index.html |
38c6c98c9919-1 | Change
v11_2
Added /Administration/license/limits 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/Administrationlicenselimits_GET/index.html |
6197334c2ff9-0 | /Administration/settings/idmMode POST
Overview
[ADMIN] Turn IDM-mode on.
Summary
This endpoint switches IDM mode on. This endpoint is only available to administrators when IDM migration is turned on and intended for internal use for IDM integration.
Request to enable IDM-mode.
{"idmMode":
{
"enabled": true,
"clientId": "mangoOIDCClientId",
"clientSecret": "mangoOIDCClientSecret",
"stsUrl": "http://sts.sugarcrm.local",
"idpUrl": "http://login.sugarcrm.local",
"stsKeySetId": "mangoOIDCKeySet",
"tid": "srn:cloud:idp:eu:0000000001:tenant", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/AdministrationsettingsidmMode_POST/index.html |
6197334c2ff9-1 | "crmOAuthScope": "https://apis.sugarcrm.com/auth/crm",
"requestedOAuthScopes": ["offline", "https://apis.sugarcrm.com/auth/crm", "profile", "email", "address", "phone"],
"cloudConsoleUrl": "http://console.sugarcrm.local",
"allowedSAs": ["srn:cloud:iam:us-west-2:9999999999:sa:user-sync"]
}
}
Refer to multiverse documenation for parameters explanation.
Response when IDM mode has been enabled
{
"tid": "srn:cloud:idp:eu:0000000001:tenant",
"clientId": "mangoOIDCClientId", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/AdministrationsettingsidmMode_POST/index.html |
6197334c2ff9-2 | "clientId": "mangoOIDCClientId",
"clientSecret": "mangoOIDCClientSecret",
"stsUrl": "http://sts.sugarcrm.local",
"idpUrl": "http://login.sugarcrm.local",
"redirectUri": "http://sugar",
"urlAuthorize": "http://sts.sugarcrm.local/oauth2/auth",
"urlAccessToken": "http://sts.sugarcrm.local/oauth2/token",
"urlResourceOwnerDetails": "http://sts.sugarcrm.local/oauth2/introspect",
"urlUserInfo": "http://sts.sugarcrm.local/userinfo",
"http_client": [], | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/AdministrationsettingsidmMode_POST/index.html |
6197334c2ff9-3 | "http_client": [],
"cloudConsoleUrl": "http://console.sugarcrm.local",
"cloudConsoleRoutes": [],
"caching": [],
"crmOAuthScope": "https://apis.sugarcrm.com/auth/crm",
"requestedOAuthScopes": [
"offline",
"https://apis.sugarcrm.com/auth/crm",
"profile",
"email",
"address",
"phone"
],
"keySetId": "mangoOIDCKeySet",
"urlKeys": "http://sts.sugarcrm.local/keys/mangoOIDCKeySet", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/AdministrationsettingsidmMode_POST/index.html |
6197334c2ff9-4 | "allowedSAs": ["srn:cloud:iam:us-west-2:9999999999:sa:user-sync"]
}
Change Log
Version
Change
v11_2
Added /Administration/settings/idmMode 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/AdministrationsettingsidmMode_POST/index.html |
872ce05b6ab3-0 | /<module>/:record/movelast/:target PUT
Overview
Move existing node as last child of 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 move node as last child
True
Response Arguments
This endpoint does not return any response arguments.
Response
This endpoint return a record GUID that was moved
"1b7b868d-7357-2e29-7513-54169bdc444d"
Change Log
Version
Change
v10 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordmovelasttarget_PUT/index.html |
872ce05b6ab3-1 | Change Log
Version
Change
v10
Added /<module>/movelast/:target 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/modulerecordmovelasttarget_PUT/index.html |
6a4e8c9d5be4-0 | /Leads/:record/freebusy GET
Get a lead's FreeBusy schedule
Summary:
This endpoint returns a list of time slots for which the specified person is busy.
Request
GET /Leads/:id/freebusy
Response
{
"id": "foo"
"module": "Users",
"freebusy": [
{
"start": "2014-08-24T08:45:00-04:00",
"end": "2014-08-24T09:15:00-04:00"
},
{
"start": "2014-08-30T05:45:00-04:00",
"end": "2014-08-30T06:15:00-04:00"
},
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Leadsrecordfreebusy_GET/index.html |
6a4e8c9d5be4-1 | },
{
"start": "2014-09-12T15:45:00-04:00",
"end": "2014-09-12T16:15:00-04: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/Leadsrecordfreebusy_GET/index.html |
01e73370d305-0 | /<module>/:record/link/:link_name GET
Overview
Lists related filtered records.
Summary
This endpoint will return a set of related records filtered by an expression. The filter can be applied to multiple
fields and have multiple and/or conditions in it. Care will need to be taken to make sure this filter has
appropriate indexes on the server side otherwise the runtime of the endpoint will be very long. Related fields can
be searched by specifying the field name as: "link_name.remote_field", so if you wished to search the Accounts
module by a related member account you would use "members.sic_code".
Request Arguments
Name
Type
Description
Required
filter
String
The filter expression. Filter expressions are explained below.
False
max_num
Integer | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html |
01e73370d305-1 | False
max_num
Integer
A maximum number of records to return. Default is 20.
False
offset
Integer
The number of records to skip over before records are returned. Default is 0.
False
fields
String
Comma delimited list of fields to return. The field date_modified will always be returned. This argument
can be combined with the view argument.
Example: name,account_type,description
False
view
String
Instead of defining the fields argument, the view argument can be used instead. The field list is
constructed at the server side based on the view definition which is requested. This argument can be used | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html |
01e73370d305-2 | 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
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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html |
01e73370d305-3 | would match any record where the field "name" starts with the value "Nelson".
Example
{
"filter":[
{
"name":{
"$starts":"Nelson"
}
}
]
}
Below is a list of operation types:
Operation
Description
$equals
Performs an exact match on that field.
$not_equals
Performs an exact match on that field.
$not_equals
Matches on non-matching values.
$starts
Matches on anything that starts with the value.
$ends
Matches anything that ends with the value.
$contains
Matches anything that contains the value | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html |
01e73370d305-4 | $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
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. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html |
01e73370d305-5 | Matches when the field is greater than the value.
$gte
Matches when the field is greater than or equal to the value.
Sub-expressions
This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.
The example expression would match if the field "name" was either "Nelson Inc" or "Nelson LLC". The only currently
accepted sub-expression types are "$and" and "$or".
Example
{
"filter":[
{
"$or":[
{
"name":"Nelson Inc"
},
{
"name":"Nelson LLC"
}
]
}
]
}
Modules | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html |
01e73370d305-6 | }
]
}
]
}
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
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. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html |
01e73370d305-7 | Array
An array of results containing matched records.
Repsonse
{
"next_offset":-1,
"records":[
{
"id":"fa300a0e-0ad1-b322-9601-512d0983c19a",
"name":"Dale Spivey",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-28T05:03:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"deleted":false, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html |
01e73370d305-8 | "description":"",
"img":"",
"deleted":false,
"assigned_user_id":"seed_sally_id",
"assigned_user_name":"Sally Bronsen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":1,
"name":"Global",
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Dale",
"last_name":"Spivey", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html |
01e73370d305-9 | "last_name":"Spivey",
"full_name":"Dale Spivey",
"title":"VP Operations",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(523) 825-4311",
"email":[
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"0" | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html |
01e73370d305-10 | "invalid_email":"0",
"primary_address":"0"
}
],
"phone_mobile":"(373) 861-0757",
"phone_work":"(212) 542-9596",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"primary_address_street":"345 Sugar Blvd.",
"primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Denver",
"primary_address_state":"CA", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html |
01e73370d305-11 | "primary_address_state":"CA",
"primary_address_postalcode":"87261",
"primary_address_country":"USA",
"alt_address_street":"",
"alt_address_street_2":"",
"alt_address_street_3":"",
"alt_address_city":"",
"alt_address_state":"",
"alt_address_postalcode":"",
"alt_address_country":"",
"assistant":"",
"assistant_phone":"",
"picture":"",
"email_and_name1":"",
"lead_source":"Campaign",
"account_name":"Smallville Resources Inc",
"account_id":"d5db6292-5c24-eb61-e202-512d09f0134e", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html |
01e73370d305-12 | "opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"DaleSpivey97",
"portal_active":true,
"portal_password":"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\/",
"portal_password1":"",
"portal_app":"",
"preferred_language":"en_us",
"campaign_id":"",
"campaign_name":"",
"c_accept_status_fields":"",
"m_accept_status_fields":"",
"accept_status_id":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html |
01e73370d305-13 | "accept_status_id":"",
"accept_status_name":"",
"sync_contact":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
},
{
"id":"95e17367-9b3d-0e26-22dc-512d0961fedf",
"name":"Florence Haddock",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-26T19:12:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html |
01e73370d305-14 | "created_by_name":"Administrator",
"description":"",
"img":"",
"deleted":false,
"assigned_user_id":"seed_sally_id",
"assigned_user_name":"Sally Bronsen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":1,
"name":"Global",
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Florence", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html |
01e73370d305-15 | "salutation":"",
"first_name":"Florence",
"last_name":"Haddock",
"full_name":"Florence Haddock",
"title":"Director Sales",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(729) 845-3137",
"email":[
{
"email_address":"[email protected]",
"opt_out":"1",
"invalid_email":"0",
"primary_address":"0"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html |
01e73370d305-16 | "opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
}
],
"phone_mobile":"(246) 233-1382",
"phone_work":"(565) 696-6981",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"primary_address_street":"111 Silicon Valley Road",
"primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Denver",
"primary_address_state":"CA", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html |
01e73370d305-17 | "primary_address_state":"CA",
"primary_address_postalcode":"79900",
"primary_address_country":"USA",
"alt_address_street":"",
"alt_address_street_2":"",
"alt_address_street_3":"",
"alt_address_city":"",
"alt_address_state":"",
"alt_address_postalcode":"",
"alt_address_country":"",
"assistant":"",
"assistant_phone":"",
"picture":"",
"email_and_name1":"",
"lead_source":"Support Portal User Registration",
"account_name":"Smallville Resources Inc",
"account_id":"d5db6292-5c24-eb61-e202-512d09f0134e", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html |
01e73370d305-18 | "opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"FlorenceHaddock169",
"portal_active":true,
"portal_password":"$1$nWFhTbK6$JF9BCGSqL\/NCrbhueX5ia0",
"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_name_GET/index.html |
01e73370d305-19 | "accept_status_id":"",
"accept_status_name":"",
"sync_contact":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
}
]
}
Change Log
Version
Change
v10
Added /<module>/:record/link/:link_name/filter GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html |
6f9cefcd6788-0 | /Users/:record/link POST
Overview
Creates relationships to a pre-existing record.
Request Arguments
Name
Type
Description
Required
<relationship link>
<string>
Link between targeted and related records.
True
<record ID>
<string>
The name value list of related records. Each item of the list may be either string equal to related item ID,
or map containing record ID ("id" key is required in this case)
and addition relationship properties.
True
Request
{
link_name: "accounts"
ids: [
"da6a3741-2a81-ba7f-f249-512d0932e94e",
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlink_POST/index.html |
6f9cefcd6788-1 | {
"id": "e689173e-c953-1e14-c215-512d0927e7a2",
"role": "owner"
}
]
}
Response Arguments
Name
Type
Description
record
Array
The record linked to related records.
related_records
Array
Records that were associated.
Response
"record": {
"id": "da6a3741-2a81-ba7f-f249-512d0932e94e",
"name": "Slender Broadband Inc - 1000 units",
"date_entered": "2013-02-26T19:12:00+00:00", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlink_POST/index.html |
6f9cefcd6788-2 | "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
},
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlink_POST/index.html |
6f9cefcd6788-3 | "primary": false
},
{
"id": "West",
"name": "West",
"name_2": "",
"primary": true
}
],
"opportunity_type": "",
"account_name": "Slender Broadband Inc",
"account_id": "181461c6-dc81-1115-1fe0-512d092e8f15",
"campaign_id": "",
"campaign_name": "",
"lead_source": "Campaign",
"amount": "25000",
"base_rate": "1",
"amount_usdollar": "25000",
"currency_id": "-99",
"currency_name": "",
"currency_symbol": "", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlink_POST/index.html |
6f9cefcd6788-4 | "currency_name": "",
"currency_symbol": "",
"date_closed": "2013-02-27",
"date_closed_timestamp": "1361992480",
"next_step": "",
"sales_stage": "Needs Analysis",
"sales_status": "New",
"probability": "90",
"best_case": "25000",
"worst_case": "25000",
"commit_stage": "include",
"my_favorite": false,
"_acl": {
"fields": {
}
}
},
"related_records": [
{
"id": "e689173e-c953-1e14-c215-512d0927e7a2", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlink_POST/index.html |
6f9cefcd6788-5 | "name": "Gus Dales",
"date_entered": "2013-02-26T19:12:00+00:00",
"date_modified": "2013-02-26T19:12:00+00:00",
"modified_user_id": "1",
"modified_by_name": "Administrator",
"created_by": "1",
"created_by_name": "Administrator",
"description": "",
"img": "",
"deleted": false,
"assigned_user_id": "seed_sally_id",
"assigned_user_name": "Sally Bronsen",
"team_name": [
{
"id": "West",
"name": "West", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlink_POST/index.html |
6f9cefcd6788-6 | {
"id": "West",
"name": "West",
"name_2": "",
"primary": true
}
],
"salutation": "",
"first_name": "Gus",
"last_name": "Dales",
"full_name": "Gus Dales",
"title": "Director Operations",
"linkedin": "",
"facebook": "",
"twitter": "",
"googleplus": "",
"department": "",
"do_not_call": false,
"phone_home": "(661) 120-2292",
"email": [
{
"email_address": "[email protected]",
"opt_out": "1", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlink_POST/index.html |
6f9cefcd6788-7 | "opt_out": "1",
"invalid_email": "0",
"primary_address": "0"
},
{
"email_address": "[email protected]",
"opt_out": "0",
"invalid_email": "0",
"primary_address": "1"
}
],
"phone_mobile": "(294) 447-9707",
"phone_work": "(036) 840-3216",
"phone_other": "",
"phone_fax": "",
"email1": "[email protected]",
"email2": "[email protected]",
"invalid_email": false, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlink_POST/index.html |
6f9cefcd6788-8 | "invalid_email": false,
"email_opt_out": false,
"primary_address_street": "48920 San Carlos Ave",
"primary_address_street_2": "",
"primary_address_street_3": "",
"primary_address_city": "Persistance",
"primary_address_state": "CA",
"primary_address_postalcode": "54556",
"primary_address_country": "USA",
"alt_address_street": "",
"alt_address_street_2": "",
"alt_address_street_3": "",
"alt_address_city": "",
"alt_address_state": "",
"alt_address_postalcode": "",
"alt_address_country": "", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlink_POST/index.html |
6f9cefcd6788-9 | "alt_address_country": "",
"assistant": "",
"assistant_phone": "",
"picture": "",
"email_and_name1": "",
"lead_source": "Support Portal User Registration",
"account_name": "Arts & Crafts Inc",
"account_id": "d43243c6-9b8e-2973-aee2-512d09bc34b4",
"opportunity_role_fields": "",
"opportunity_role_id": "",
"opportunity_role": "Technical Advisor",
"reports_to_id": "",
"report_to_name": "",
"portal_name": "GusDales145",
"portal_active": true, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlink_POST/index.html |
6f9cefcd6788-10 | "portal_active": true,
"portal_password": "$1$JxYr6tmM$b.O6.KF42jP46RadSwz0N0",
"portal_password1": "",
"portal_app": "",
"preferred_language": "en_us",
"campaign_id": "",
"campaign_name": "",
"c_accept_status_fields": "",
"m_accept_status_fields": "",
"accept_status_id": "",
"accept_status_name": "",
"sync_contact": "",
"my_favorite": false,
"_acl": {
"fields": {
}
}
},
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlink_POST/index.html |
6f9cefcd6788-11 | "fields": {
}
}
},
{
"id": "da6a3741-2a81-ba7f-f249-512d0932e94e",
"name": "Slender Broadband Inc - 1000 units",
"date_entered": "2013-02-26T19:12:00+00:00",
"date_modified": "2013-02-26T19:12:00+00:00",
"modified_user_id": "1",
"modified_by_name": "Administrator",
"created_by": "1",
"created_by_name": "Administrator",
"description": "",
"img": "", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlink_POST/index.html |
6f9cefcd6788-12 | "description": "",
"img": "",
"last_activity_date": "2013-02-28T18:36:00+00:00",
"deleted": false,
"assigned_user_id": "seed_max_id",
"assigned_user_name": "Max Jensen",
"team_name": [
{
"id": "East",
"name": "East",
"name_2": "",
"primary": false
},
{
"id": "West",
"name": "West",
"name_2": "",
"primary": true
}
],
"opportunity_type": "",
"account_name": "Slender Broadband Inc", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlink_POST/index.html |
6f9cefcd6788-13 | "account_name": "Slender Broadband Inc",
"account_id": "181461c6-dc81-1115-1fe0-512d092e8f15",
"campaign_id": "",
"campaign_name": "",
"lead_source": "Campaign",
"amount": "25000",
"base_rate": "1",
"amount_usdollar": "25000",
"currency_id": "-99",
"currency_name": "",
"currency_symbol": "",
"date_closed": "2013-02-27",
"date_closed_timestamp": "1361992480",
"next_step": "",
"sales_stage": "Needs Analysis",
"sales_status": "New", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlink_POST/index.html |
6f9cefcd6788-14 | "sales_status": "New",
"probability": "90",
"best_case": "25000",
"worst_case": "25000",
"commit_stage": "include",
"my_favorite": false,
"_acl": {
"fields": {
}
}
}
]
}
Change Log
Version
Change
v10 (7.6.0)
Added support for additional relationship values.
v10 (7.1.5)
Added /<module>/:record/link POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlink_POST/index.html |
387b74fd7736-0 | /<module>/file/vcard_import POST
Overview
Imports a person record from a vcard.
Request Arguments
Name
Type
Description
Required
format
String
The data format. Currently accepts 'sugar-html-json'.
True
module
String
The name of the module to import the vcard to.
True
file
String
The vcard contents.
True
Request
{
"format":"sugar-html-json",
"module":"Contacts"
"file":"@\/path\/to\/ExampleContact.vcf"
}
Response Arguments
Name
Type
Description
file
String
The id of the imported vcard. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilevcard_import_POST/index.html |
387b74fd7736-1 | file
String
The id of the imported vcard.
Response
{
"file":"2c9e5c09-6824-0d14-f5cb-5130321ac3cf"
}
Change Log
Version
Change
v10
Added /<module>/file/vcard_import 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/modulefilevcard_import_POST/index.html |
744346707028-0 | /Administration/packages GET
Overview
[ADMIN] PackageManager list packages.
Summary
Lists all packages in the system.
Response
{
"packages": [
{
"name": "project_P3",
"version": "1580885734",
"type": "module",
"published_date": "2020-02-06 12:51:17",
"description": "",
"uninstallable": true,
"file_install": "cd590eb069a73b2eeb6c107776fd60dc",
"file": "cd590eb069a73b2eeb6c107776fd60dc",
"enabled": "ENABLED", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationpackages_GET/index.html |
744346707028-1 | "enabled": "ENABLED",
"id": "66172e0e-48df-11ea-9f1f-acde48001122",
"installed": true
},
{
"name": "project_P1",
"version": 1580885419,
"published_date": "2020-02-05 06:50:19",
"description": "None",
"uninstallable": "Yes",
"type": "Module",
"file": "0ef4dd8b237f4358bdb246a744eb2b38",
"file_install": "5d4b4614421586fd2111714abf622392",
"unFile": "5d4b4614421586fd2111714abf622392", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationpackages_GET/index.html |
744346707028-2 | "installed": false
}
]
}
Change Log
Version
Change
v11.8
Added /Administration/packages 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/Administrationpackages_GET/index.html |
ef06e1ae3516-0 | /Meetings/:record/external GET
Retrieves info about launching an external meeting
Summary:
This endpoint is used to retrieve info about launching an external meeting. This includes whether the current user
has permission to host and/or join the meeting along with the host/join URLs.
Query Parameters:
Param
Description
Optional
This endpoint does not accept any parameters.
Input Example:
Output Example:
{
"is_host_option_allowed": false,
"host_url": "",
"is_join_option_allowed": true,
"join_url": "//link.to/external/meeting"
}
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/Meetingsrecordexternal_GET/index.html |
22f162c4f454-0 | /Forecasts/config POST
Creates and/or updates the config settings for the Forecasts module
Summary:
This endpoint is used to create and/or update the config settings for the Forecasts module as json data. It extends
the core config endpoint by adding the functionality to create
the Timeperiods and updates existing Opportunities for use in the Forecasts module.
Query Parameters:
Param
Description
Optional
Input Example:
{
"is_setup": 1,
"is_upgrade": 0,
"has_commits": 1,
"timeperiod_type": "chronological",
"timeperiod_interval": "Annual",
"timeperiod_leaf_interval": "Quarter",
"timeperiod_start_date": "2013-01-01",
"timeperiod_shown_forward": 2, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsconfig_POST/index.html |
22f162c4f454-1 | "timeperiod_shown_forward": 2,
"timeperiod_shown_backward": 2,
"forecast_ranges": "show_binary",
"buckets_dom": "commit_stage_binary_dom",
"show_binary_ranges": {
"include": {
"min": 70,
"max": 100
},
"exclude": {
"min": 0,
"max": 69
}
},
"show_buckets_ranges": {
"include": {
"min": 85,
"max": 100
},
"upside": {
"min": 70,
"max": 84
},
"exclude": {
"min": 0,
"max": 69
}
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsconfig_POST/index.html |
22f162c4f454-2 | "min": 0,
"max": 69
}
},
"sales_stage_won": [
"Closed Won"
],
"sales_stage_lost": [
"Closed Lost"
],
"show_worksheet_likely": 1,
"show_worksheet_best": 1,
"show_worksheet_worst": 0,
"show_projected_likely": 1,
"show_projected_best": 1,
"show_projected_worst": 0,
"show_forecasts_commit_warnings": 1
}
Output Example:
{
"is_setup": 1,
"is_upgrade": 0,
"has_commits": 1,
"timeperiod_type": "chronological", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsconfig_POST/index.html |
22f162c4f454-3 | "timeperiod_type": "chronological",
"timeperiod_interval": "Annual",
"timeperiod_leaf_interval": "Quarter",
"timeperiod_start_date": "2013-01-01",
"timeperiod_shown_forward": 2,
"timeperiod_shown_backward": 2,
"forecast_ranges": "show_binary",
"buckets_dom": "commit_stage_binary_dom",
"show_binary_ranges": {
"include": {
"min": 70,
"max": 100
},
"exclude": {
"min": 0,
"max": 69
}
},
"show_buckets_ranges": {
"include": {
"min": 85, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsconfig_POST/index.html |
22f162c4f454-4 | "include": {
"min": 85,
"max": 100
},
"upside": {
"min": 70,
"max": 84
},
"exclude": {
"min": 0,
"max": 69
}
},
"sales_stage_won": [
"Closed Won"
],
"sales_stage_lost": [
"Closed Lost"
],
"show_worksheet_likely": 1,
"show_worksheet_best": 1,
"show_worksheet_worst": 0,
"show_projected_likely": 1,
"show_projected_best": 1,
"show_projected_worst": 0,
"show_forecasts_commit_warnings": 1 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsconfig_POST/index.html |
22f162c4f454-5 | "show_forecasts_commit_warnings": 1
}
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/Forecastsconfig_POST/index.html |
0e0ab4306a84-0 | /<module>/:record/link/:link_name/:remote_id DELETE
Overview
Deletes an existing relationship between two records.
Request Arguments
This endpoint does not accept any arguments.
Response Arguments
Name
Type
Description
record
Array
The record to disassociate from the related record.
related_record
Array
The record that was disassociated.
Response
{
"record":{
"id":"da6a3741-2a81-ba7f-f249-512d0932e94e",
"name":"Slender Broadband Inc - 1000 units",
"date_entered":"2013-02-26T19:12:00+00:00", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_DELETE/index.html |
0e0ab4306a84-1 | "date_modified":"2013-02-26T19:12:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"last_activity_date":"2013-02-28T18:36:00+00:00",
"deleted":false,
"assigned_user_id":"seed_max_id",
"assigned_user_name":"Max Jensen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_DELETE/index.html |
0e0ab4306a84-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/modulerecordlinklink_nameremote_id_DELETE/index.html |
0e0ab4306a84-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/modulerecordlinklink_nameremote_id_DELETE/index.html |
0e0ab4306a84-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/modulerecordlinklink_nameremote_id_DELETE/index.html |
0e0ab4306a84-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/modulerecordlinklink_nameremote_id_DELETE/index.html |
0e0ab4306a84-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/modulerecordlinklink_nameremote_id_DELETE/index.html |
0e0ab4306a84-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/modulerecordlinklink_nameremote_id_DELETE/index.html |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.