id
stringlengths 14
16
| text
stringlengths 33
5.27k
| source
stringlengths 105
270
|
|---|---|---|
205f5b399519-6 | "labelModule": "Quotes"
},
{
"name": "mft_part_num",
"label": "LBL_MFT_PART_NUM",
"type": "base",
"labelModule": "Products"
},
{
"name": "discount_price",
"label": "LBL_DISCOUNT_PRICE",
"type": "currency",
"convertToBase": true,
"showTransactionalAmount": true,
"related_fields": [
"discount_price",
"currency_id",
"base_rate"
],
"labelModule": "Products"
},
{
"name": "discount",
"type": "fieldset",
"css_class": "quote-discount-percent",
"label": "LBL_DISCOUNT_AMOUNT",
"fields": [
{
"name": "discount_amount",
"label": "LBL_DISCOUNT_AMOUNT",
"type": "discount",
"convertToBase": true,
"showTransactionalAmount": true
},
{
"type": "discount-select",
"name": "discount_select",
"no_default_action": true,
"buttons": [
{
"type": "rowaction",
"name": "select_discount_amount_button",
"label": "LBL_DISCOUNT_AMOUNT",
"event": "button:discount_select_change:click"
},
{
"type": "rowaction",
"name": "select_discount_percent_button",
"label": "LBL_DISCOUNT_PERCENT",
"event": "button:discount_select_change:click"
}
],
"label": "LBL_DISCOUNT_AS_PERCENT" | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html |
205f5b399519-7 | }
],
"label": "LBL_DISCOUNT_AS_PERCENT"
}
],
"labelModule": "Products"
},
{
"name": "total_amount",
"label": "LBL_LINE_ITEM_TOTAL",
"type": "currency",
"widthClass": "cell-medium",
"showTransactionalAmount": true,
"related_fields": [
"total_amount",
"currency_id",
"base_rate"
],
"labelModule": "Quotes"
}
],
"footer_rows": [
{
"name": "new_sub",
"type": "currency"
},
{
"name": "tax",
"type": "currency"
},
{
"name": "shipping",
"type": "quote-footer-currency",
"css_class": "quote-footer-currency",
"default": "0.00"
},
{
"name": "total",
"type": "currency",
"css_class": "grand-total"
}
],
"summary_columns_related_fields": [
"base_rate",
"deal_tot",
"deal_tot_usdollar",
"shipping",
"subtotal",
"subtotal_usdollar",
"tax",
"taxable_subtotal"
],
"worksheet_columns_related_fields": [
"base_rate",
"deal_calc",
"discount_amount",
"discount_price",
"discount_select",
"quantity",
"subtotal",
"tax_class",
"total_amount",
"description",
"quote_id", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html |
205f5b399519-8 | "total_amount",
"description",
"quote_id",
"name",
"product_template_id",
"product_template_name"
],
"footer_rows_related_fields": [
"deal_tot",
"deal_tot_usdollar",
"shipping",
"subtotal",
"subtotal_usdollar",
"tax",
"taxable_subtotal"
]
}
Change Log
Version
Change
v11.3
Added /Quotes/config POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html |
81de8ae25111-0 | /Meetings POST
Overview
Create a single event or a series of event records.
Request Arguments
Name
Type
Description
Required
<record field>
<record field type>
The name value list of fields to populate.
True
Request
{
"name":"Department Meeting",
"description":"Weekly Department Meeting",
"date_start":"yyyy-mm-ddThh:mm:ss-00:00",
"date_end":"yyyy-mm-ddThh:mm:ss-00:00",
"repeat_type":"Weekly",
"repeat_interval":"1", /* Every Week */
"repeat_dow":"25", /* Tue and Fri */
"repeat_count":"4", /* 4 Recurrences */
"repeat_until":"",
}
Response Arguments
Name
Description
Start Date
End Date
<record field>
Returns the fields for the newly created record.
Response
{
}
Change Log
Version
Change
v10
Added /<module> POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Meetings_POST/index.html |
f89a4854cc4b-0 | /Mail/recipients/find GET
Overview
Finds recipients that match the search term.
Request Arguments
Name
Type
Description
Required
q
string
The search string
False
module_list
string
One of the following strings: users, accounts, contacts, leads, prospects, all
Will determine which modules are searched using the given search string.
False
order_by
string
columns to sort by (one or more of $sortableColumns) with direction
Example: name:asc,id:desc (will sort by last_name ASC and then id DESC)
False
offset
int
Offset of first record to return
False
max_num
int
Maximum records to return
False
Request
?q=foo&module_list=all&order_by=name:asc,id:desc&offset=1&max_num=4
Response Arguments
Name
Type
Description
next_offset
int
Returns the next offset to be used if paging ahead for more records
records
Array
Array of records found based on the search string and module_list. Each record contains the ID, module,
name, email address and it's ID, opt out flag of the email address, and _acl of the recipient found.
Response
{
"next_offset": 3,
"records": [
{
"id": "seed_sarah_id",
"_module": "Users",
"name": "Sarah Smith",
"email": "[email protected]", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailrecipientsfind_GET/index.html |
f89a4854cc4b-1 | "name": "Sarah Smith",
"email": "[email protected]",
"email_address_id": "962cefa8-2f1t-11e6-9bee-80e6577b09a3",
"opt_out": false
"_acl": {
"fields": {
"assigned_user_id": {
"write":"no",
"create":"no"
},
"date_sent": {
"write":"no",
"create":"no"
}
}
}
},
{
"id": "962cefa8-2f1f-11e6-9ade-80e6500b09a0",
"_module": "Leads",
"name": "Antonia Piermarini",
"email": "[email protected]",
"email_address_id": "756yafa8-2f1t-11e6-9bee-80e6577b09a3",
"opt_out": true
"_acl": {
"fields": {
"assigned_user_id": {
"write":"no",
"create":"no"
},
"date_sent": {
"write":"no",
"create":"no"
}
}
}
},
{
"id": "962850e2-2f1f-11e6-804e-80e6500b09a0",
"_module": "Leads",
"name": "Santa Leffingwell",
"email": "[email protected]", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailrecipientsfind_GET/index.html |
f89a4854cc4b-2 | "email": "[email protected]",
"email_address_id": "211uhhg4-2f1t-11e6-9bee-80e6577b09a3",
"opt_out": false
"_acl": {
"fields": {
"assigned_user_id": {
"write":"no",
"create":"no"
},
"date_sent": {
"write":"no",
"create":"no"
}
}
}
}
]
}
Change Log
Version
Change
v10
Added /Mail/recipients/find 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/Mailrecipientsfind_GET/index.html |
8cb39103441a-0 | /Mail/attachment/cache DELETE
Overview
Clears the user's attachment cache directory
Query Parameters:
This endpoint does not accept any parameters.
Input Example:
This endpoint does not accept any input.
Output Example:
If successful, the endpoint responds with a bool of true.
Change Log
Version
Change
v11
Last version in which /Mail/attachment/cache DELETE is available. Attachments are no longer
written as temporary files to the current user's cache directory.
v10
Added /Mail/attachment/cache DELETE endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailattachmentcache_DELETE/index.html |
2de81023794e-0 | /Forecasts/init GET
ForecastsApi - init
Summary:
This endpoint is used to return initialization data for the Forecasts module.
Query Parameters:
Param
Description
Optional
This endpoint does not accept any parameters.
Input Example:
Output Example:
{
"initData":
{
"selectedUser":
{
"preferences":
{
"timezone":"GMT",
"datepref":"m\/d\/Y",
"timepref":"h:ia",
"currency_id":"-99",
"currency_name":"US Dollars",
"currency_symbol":"$",
"currency_iso":"USD",
"currency_rate":1,
"decimal_precision":"2",
"decimal_separator":".",
"number_grouping_separator":",",
"language":"en_us",
"default_teams":
[{
"id":1,
"display_name":"Global",
"name":"Global",
"name_2":"",
"primary":true
}]
},
"module_list":
[
"Home",
"Accounts",
"Contacts",
"Opportunities",
"Leads","Calendar",
"Reports",
"Quotes",
"Documents",
"Emails",
"Campaigns",
"Calls",
"Meetings",
"Tasks",
"Notes",
"Forecasts",
"Cases",
"Prospects",
"ProspectLists",
"Bugs",
"Employees"
],
"type":"user",
"id":"seed_jim_id",
"full_name":"Jim Brennan",
"user_name":"jim", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsinit_GET/index.html |
2de81023794e-1 | "full_name":"Jim Brennan",
"user_name":"jim",
"picture":"46d1fbfb-c258-ce81-fa3a-50f809925709",
"acl":
{
"Forecasts":{"fields":[],"admin":"no","_hash":"095777549714234c8192a7a7963c38b8"},
"ForecastWorksheets":{"fields":[],"admin":"no","_hash":"095777549714234c8192a7a7963c38b8"},
"ForecastManagerWorksheets":{"fields":[],"admin":"no","_hash":"095777549714234c8192a7a7963c38b8"},
},
"my_teams":
[
{"id":"8833dfef-c1f4-e8b3-ca3b-50f8093616be","name":"Chris Olliver"},
{"id":"East","name":"East"},{"id":1,"name":"Global"},
{"id":"4ae6baba-f356-7374-7eb4-50f809745551","name":"Jim Brennan"},
{"id":"707a642a-710b-37f1-88f6-50f8098205c0","name":"Max Jensen"},
{"id":"63308ab9-f663-bae8-90a5-50f80951c0fe","name":"Sally Bronsen"},
{"id":"5776c705-8e6e-4bfc-44e5-50f809d12c0e","name":"Sarah Smith"},
{"id":"West","name":"West"}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsinit_GET/index.html |
2de81023794e-2 | {"id":"West","name":"West"},
{"id":"7cf7ee0b-f88e-b566-d4d3-50f809dcb717","name":"Will Westin"}
],
"showOpps":false,
"first_name":"Jim",
"last_name":"Brennan",
"admin":"yes"
},
"forecasts_setup":1
},
"defaultSelections":
{
"timeperiod_id":
{
"id":"a2ab9ad3-2101-36f8-7ba3-50f809b3b62c",
"label":"Q1 (01\/01\/2013 - 03\/31\/2013)"
},
"ranges":["include"],
"group_by":"forecast",
"dataset":"likely"
}
}
}
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/Forecastsinit_GET/index.html |
562a206e034a-0 | /pmse_Emails_Templates/:/find_modules GET
Overview
Get the related module list for a module
Summary
This endpoint will retrieve a list of related modules that can be accessed in
the Process Email Templates definition from the specified module. Input
parameters are passed in as the URL query string. Pagination is supported.
Request Arguments
Name
Type
Description
Required
module_list
String
The name of the module the retrieved module list is related to.
True
Request
rest/v11/pmse_Emails_Templates/Quotes/find_modules?module_list=Quotes
Response Arguments
Name
Type
Description
search
String
The value of the input module_list parameter.
success
Boolean
Whether the related module list has been successfully retrieved.
result
Array
An array of related module objects.
Response
{
"search":"Quotes",
"success":true,
"result":[
{
"value":"Quotes",
"text":"\u003CQuotes\u003E",
"module":"Quotes",
"module_label":"Quotes",
"module_name":"Quotes",
"relationship":"Quotes"
},
{
"value":"billing_accounts",
"text":"Accounts (Bill to Account: billing_accounts)",
"module":"Accounts",
"module_label":"Accounts",
"module_name":"Accounts",
"relationship":"quotes_billto_accounts"
},
{
"value":"shipping_accounts",
"text":"Accounts (Ship to Account: shipping_accounts)",
"module":"Accounts",
"module_label":"Accounts",
"module_name":"Accounts",
"relationship":"quotes_shipto_accounts"
},
{
"value":"billing_contacts", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templatesfind_modules_GET/index.html |
562a206e034a-1 | },
{
"value":"billing_contacts",
"text":"Contacts (Bill to Contact: billing_contacts)",
"module":"Contacts",
"module_label":"Contacts",
"module_name":"Contacts",
"relationship":"quotes_contacts_billto"
},
{
"value":"shipping_contacts",
"text":"Contacts (Ship to Contact: shipping_contacts)",
"module":"Contacts",
"module_label":"Contacts",
"module_name":"Contacts",
"relationship":"quotes_contacts_shipto"
},
{
"value":"contracts",
"text":"Contracts (Contracts: contracts)",
"module":"Contracts",
"module_label":"Contracts",
"module_name":"Contracts",
"relationship":"contracts_quotes"
},
{
"value":"opportunities",
"text":"Opportunities (Opportunity: opportunities)",
"module":"Opportunities",
"module_label":"Opportunities",
"module_name":"Opportunities",
"relationship":"quotes_opportunities"
},
{
"value":"assigned_user_link",
"text":"Users (Assigned to User: assigned_user_link)",
"module":"Users",
"module_label":"Users",
"module_name":"Users",
"relationship":"quotes_assigned_user"
},
{
"value":"created_by_link",
"text":"Users (Created by User: created_by_link)",
"module":"Users",
"module_label":"Users",
"module_name":"Users",
"relationship":"quotes_created_by"
},
{
"value":"modified_user_link",
"text":"Users (Modified by User: modified_user_link)", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templatesfind_modules_GET/index.html |
562a206e034a-2 | "text":"Users (Modified by User: modified_user_link)",
"module":"Users",
"module_label":"Users",
"module_name":"Users",
"relationship":"quotes_modified_user"
}
]
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templatesfind_modules_GET/index.html |
79335b7f8051-0 | /TimePeriods/filter GET
Overview
Lists filtered records.
Summary
This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields
and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.
If both a filter definition and a filter id are passed, the two filters will be joined with an AND.
Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise
the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:
"link_name.remote_field", so if you wished to search the Accounts module by a related member account you would
use "members.sic_code".
Request Arguments
Name
Type
Description
Required
filter
String
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
A maximum number of records to return. Default is 20.
False
offset
Integer | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriodsfilter_GET/index.html |
79335b7f8051-1 | 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
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
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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriodsfilter_GET/index.html |
79335b7f8051-2 | 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
This expression allows you to specify what operation you want to use for filtering on the field. In the example you
would match any record where the field "name" starts with the value "Nelson".
Example
{
"filter":[
{
"name":{
"$starts":"Nelson"
}
}
]
}
Below is a list of operation types:
Operation
Description
$equals
Performs an exact match on that field.
$not_equals
Performs an exact match on that field.
$not_equals
Matches on non-matching values.
$starts
Matches on anything that starts with the value.
$ends
Matches anything that ends with the value.
$contains
Matches anything that contains the value
$in
Finds anything where field matches one of the values as specified as an array.
$not_in
Finds anything where field does not matches any of the values as specified as an array.
$is_null | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriodsfilter_GET/index.html |
79335b7f8051-3 | $is_null
Checks if the field is null. This operation does not need a value specified.
$not_null
Checks if the field is not null. This operation does not need a value specified.
$lt
Matches when the field is less than the value.
$lte
Matches when the field is less than or equal to the value.
$gt
Matches when the field is greater than the value.
$gte
Matches when the field is greater than or equal to the value.
Sub-expressions
This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.
The example expression would match if the field "name" was either "Nelson Inc" or "Nelson LLC". The only currently
accepted sub-expression types are "$and" and "$or".
Example
{
"filter":[
{
"$or":[
{
"name":"Nelson Inc"
},
{
"name":"Nelson LLC"
}
]
}
]
}
Modules
There are two module expressions, they operate on modules instead of fields. The current module can be specified by
either using the module name "_this" or by leaving the module name as a blank string. The example expression would
filter the records in the current module to only your favorites. The only currently accepted module expressions are
"$favorite" and "$owner".
Example
{
"filter":[
{
"$favorite":"_this"
}
]
}
Response Arguments
Name
Type
Description
next_offset | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriodsfilter_GET/index.html |
79335b7f8051-4 | ]
}
Response Arguments
Name
Type
Description
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more
records.
records
Array
An array of results containing matched records.
Response
{
"next_offset":-1,
"records":[
{
"id":"fa300a0e-0ad1-b322-9601-512d0983c19a",
"name":"Dale Spivey",
"date_modified":"2013-02-28T05:03:00+00:00",
"description":"",
"opportunities": [
{
_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": [
{
_module: "Opportunities" | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriodsfilter_GET/index.html |
79335b7f8051-5 | {
_module: "Opportunities"
date_modified: "2014-09-08T16:05:00+03:00"
id: "9ce7c088-8ee4-7cd3-18f1-540da944d4c0"
name: "360 Vacations - 312 Units"
sales_status: "New"
},
],
"_acl": {
"fields": {
}
}
}
]
}
Change Log
Version
Change
v10
Added /<module>/filter GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriodsfilter_GET/index.html |
5c698c39e33c-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",
"date_modified":"2013-02-26T19:12:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"last_activity_date":"2013-02-28T18:36:00+00:00",
"deleted":false,
"assigned_user_id":"seed_max_id",
"assigned_user_name":"Max Jensen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"opportunity_type":"",
"account_name":"Slender Broadband Inc", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_DELETE/index.html |
5c698c39e33c-1 | "opportunity_type":"",
"account_name":"Slender Broadband Inc",
"account_id":"181461c6-dc81-1115-1fe0-512d092e8f15",
"campaign_id":"",
"campaign_name":"",
"lead_source":"Campaign",
"amount":"25000",
"base_rate":"1",
"amount_usdollar":"25000",
"currency_id":"-99",
"currency_name":"",
"currency_symbol":"",
"date_closed":"2013-02-27",
"date_closed_timestamp":"1361992480",
"next_step":"",
"sales_stage":"Needs Analysis",
"sales_status":"New",
"probability":"90",
"best_case":"25000",
"worst_case":"25000",
"commit_stage":"include",
"my_favorite":false,
"_acl":{
"fields":{
}
}
},
"related_record":{
"id":"e689173e-c953-1e14-c215-512d0927e7a2",
"name":"Gus Dales",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-26T19:12:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"deleted":false,
"assigned_user_id":"seed_sally_id", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_DELETE/index.html |
5c698c39e33c-2 | "deleted":false,
"assigned_user_id":"seed_sally_id",
"assigned_user_name":"Sally Bronsen",
"team_name":[
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Gus",
"last_name":"Dales",
"full_name":"Gus Dales",
"title":"Director Operations",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(661) 120-2292",
"email":[
{
"email_address":"[email protected]",
"opt_out":"1",
"invalid_email":"0",
"primary_address":"0"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
}
],
"phone_mobile":"(294) 447-9707",
"phone_work":"(036) 840-3216",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"primary_address_street":"48920 San Carlos Ave",
"primary_address_street_2":"",
"primary_address_street_3":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_DELETE/index.html |
5c698c39e33c-3 | "primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Persistance",
"primary_address_state":"CA",
"primary_address_postalcode":"54556",
"primary_address_country":"USA",
"alt_address_street":"",
"alt_address_street_2":"",
"alt_address_street_3":"",
"alt_address_city":"",
"alt_address_state":"",
"alt_address_postalcode":"",
"alt_address_country":"",
"assistant":"",
"assistant_phone":"",
"picture":"",
"email_and_name1":"",
"lead_source":"Support Portal User Registration",
"account_name":"Arts & Crafts Inc",
"account_id":"d43243c6-9b8e-2973-aee2-512d09bc34b4",
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"GusDales145",
"portal_active":true,
"portal_password":"$1$JxYr6tmM$b.O6.KF42jP46RadSwz0N0",
"portal_password1":"",
"portal_app":"",
"preferred_language":"en_us",
"campaign_id":"",
"campaign_name":"",
"c_accept_status_fields":"",
"m_accept_status_fields":"",
"accept_status_id":"",
"accept_status_name":"",
"sync_contact":"",
"my_favorite":false,
"_acl":{
"fields":{
} | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_DELETE/index.html |
5c698c39e33c-4 | "_acl":{
"fields":{
}
}
}
}
Change Log
Version
Change
v10
Added /<module>/:record/link/:link_name/:remote_id DELETE endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_DELETE/index.html |
19b22d3aaff6-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,
"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
}
},
"sales_stage_won": [
"Closed Won"
],
"sales_stage_lost": [
"Closed Lost"
], | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsconfig_POST/index.html |
19b22d3aaff6-1 | ],
"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",
"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,
"max": 100
},
"upside": {
"min": 70,
"max": 84
},
"exclude": {
"min": 0,
"max": 69
}
},
"sales_stage_won": [
"Closed Won"
], | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsconfig_POST/index.html |
19b22d3aaff6-2 | "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
}
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 |
00698362cccf-0 | /<module>/:record/subscribe POST
Summary:
This endpoint creates a subscription record in the Subscriptions table, from a specified record and module. It allows the user to be subscribed to activity stream messages for the record being subscribed to, or "followed".
Query Parameters:
This endpoint does not accept any parameters.
Input Example:
This endpoint does not accept any input.
Output Example:
If successful, the endpoint responds with the GUID of the subscription record.
"96ad733c-df51-dd9d-1888-514112ef0595"
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/modulerecordsubscribe_POST/index.html |
d02a1411032e-0 | /me/following GET
Overview
Returns all of the current users followed records
Request Arguments
limit and offset are available query parameters.
Response Arguments
Name
Type
Description
Â
Â
Â
Response
{
}
Change Log
Version
Change
v10
Added /me/following 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/mefollowing_GET/index.html |
4e52db436e01-0 | /Users/:record/freebusy GET
Get a user's FreeBusy schedule
Summary:
This endpoint returns a list of time slots for which the specified person is busy.
Request
GET /Users/: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"
},
{
"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/Usersrecordfreebusy_GET/index.html |
9897e84b1b33-0 | /pmse_Project/GatewayDefinition/:record PUT
Overview
Updates the definition data for a gateway
Summary
This endpoint will update the Process Definition gateway identified by the
record input parameter with the data provided by the request
payload.
Request Arguments
Name
Type
Description
Required
record
String
The value for the gat_uid field in the pmse_bpmn_gateway record
True
Request Payload
{
"data":
[
{
"flo_uid":"985528634573cabc8901d04029355451",
"flo_condition":""
}
]
}
Response Arguments
Name
Type
Description
success
Boolean
The status of the update 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_ProjectGatewayDefinitionrecord_PUT/index.html |
e9c263922b49-0 | /DataArchiver/:id/run POST
Overview
[ADMIN] Performs the archiving process.
Summary
Performs the archiving process for the given archive definition. This endpoint is only available to administrators.
Request Arguments
This endpoint does not accept any request arguments.
Response
This API returns the ID of the created ArchiveRun bean.
Change Log
Version
Change
v11_11
Added /DataArchiver/:id/run POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/DataArchiveridrun_POST/index.html |
d149b2ae7948-0 | /pmse_Inbox/delete_notes/:id DELETE
Overview
Deletes a process note
Summary
TBD
Request Arguments
Name
Type
Description
Required
id
string
The note id to delete
true
Response Arguments
Name
Type
Description
id
string
Id of the deleted note
Response
{
"id":"da13553a-298a-11e6-b125-6c4008960436"
}
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_Inboxdelete_notesid_DELETE/index.html |
0a21354f104a-0 | /ForecastWorksheets/:timeperiod_id GET
Returns a collection of ForecastWorksheet models
Summary:
This end point is used to return the Worksheets for a user at a given timeperiod. If no timeperiod is provide it
will use the default timeperiod, likewise if no user is provided, it will default to the logged in user.
Also this end points use the visibility requirements set forth by the application, that if the records being requested
belong to you, you will get the draft version, If the worksheet is not yours, you will only see the committed version.
Url Parameters:
Param
Description
Optional
timeperiod_id
Show for a specific time period, defaults to the current time period if one is not passed
Optional
user_id
Show for a specific user, defaults to current user if not defined
Optional
Query Parameters:
Param
Description
Optional
type
Which type to return, currently the ones that are supported are, opportunity and product
Optional
Possible Errors
Error
Description
412 - Invalid Parameter
When the passed in timeperiod and/or user can not be found
403 - Not Authorized
If you are not a manager, but you are tyring to view another sales rep forecast worksheet, you will receive a 403 Not Authorized Error
Url Example:
/rest/v10/ForecastWorksheets/:timeperiod_id/:user_id
Output Example:
{ "next_offset": -1,
"records": [
{
"id": "ad3908c7-83a3-f360-c223-51117844c208",
"name": "Grow-Fast Inc - 1000 units",
"date_entered": "2013-02-05T21:22:00+00:00", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetstimeperiod_id_GET/index.html |
0a21354f104a-1 | "date_modified": "2013-02-05T21:22:00+00:00",
"modified_user_id": "1",
"modified_by_name": "Administrator",
"created_by": "1",
"created_by_name": "Administrator",
"description": "",
"img": "",
"deleted": "0",
"assigned_user_id": "seed_jim_id",
"assigned_user_name": "Jim Brennan",
"team_name": [
{
"id": "East",
"name": "East",
"name_2": "",
"primary": true
}
],
"parent_id": "50b90565-e748-ed77-d9d7-511178f5acae",
"parent_type": "Opportunities",
"account_name": "",
"account_id": "",
"likely_case": "75000",
"best_case": "75000",
"worst_case": "75000",
"base_rate": "1",
"currency_id": "-99",
"currency_name": "",
"currency_symbol": "",
"date_closed": "2013-02-10",
"date_closed_timestamp": "1360531443",
"sales_stage": "Perception Analysis",
"probability": "70",
"commit_stage": "include",
"draft": "1",
"my_favorite": false,
"_acl": {
"fields": {}
}
}]
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetstimeperiod_id_GET/index.html |
830580884fdf-0 | /EmailAddresses/:record PUT
Overview
Update an existing email address.
Summary
The email_address parameter is not supported as email addresses are immutable.
Request Arguments
Name
Type
Description
Required
invalid_email
Boolean
true if the email address is invalid.
False
opt_out
Boolean
true if the email address is opted out.
False
Request
{
"opt_out": true
}
Response Arguments
Name
Type
Description
<record field>
<record field type>
Returns the fields for the updated record.
Response
{
"id": "a028341c-ba92-9343-55e7-56cf5beda121",
"date_created": "2016-02-25T11:53:07-08:00",
"date_modified": "2016-02-25T11:53:07-08:00",
"deleted": false,
"email_address": "[email protected]",
"email_address_caps": "[email protected]",
"invalid_email": false,
"opt_out": true,
"_acl": {
"fields": {}
},
"_module": "EmailAddresses"
}
Change Log
Version
Change
v10
Added /EmailAddresses/: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/EmailAddressesrecord_PUT/index.html |
bd7fce9ff647-0 | /help/exceptions GET
Overview
Fetches the documentation on which exceptions are thrown by the API, their
HTTP codes, their default messages and a brief description of what the exception
means.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
<html>
String
Returns the html of the help doc
Response
The HTML document of the exception help page.
Change Log
Version
Change
v10
Added /help/exceptions 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/helpexceptions_GET/index.html |
46f4a5877ab1-0 | /Emails/:record PUT
Overview
Update an existing Emails record.
Summary
Used for updating an archived email, updating a draft to send later, or sending a draft.
Updating an Archived Email
Request Arguments
Name
Type
Description
Required
message_uid
String
Only use this field for updating emails imported from an IMAP server, as this is the email's IMAP UID.
False
assigned_user_id
String
The assigned user's ID.
False
parent_type
String
The parent record's module.
False
parent_id
String
The parent record's ID.
False
team_name
List
List of teams that can access the email.
False
Request
{
"assigned_user_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
"parent_type": "Leads",
"parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6",
"team_name": [{
"id": "1",
"display_name": "Global",
"name": "Global",
"name_2": "",
"primary": true,
"selected": false
}]
}
Response
{
"id": "a028341c-ba92-9343-55e7-56cf5beda121", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
46f4a5877ab1-1 | "date_entered": "2016-02-25T11:53:07-08:00",
"created_by": "9c61c46a-a7c5-df71-481c-51d48232f820",
"created_by_name": "Sarah Smith",
"date_modified": "2016-02-25T11:53:07-08:00",
"modified_by_name": "Sarah Smith",
"modified_user_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
"deleted": false,
"assigned_user_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
"assigned_user_name": "Sarah Smith",
"state": "Archived",
"name": "Re: Discuss Proposal",
"description": "Now is a good time",
"description_html": "<p>Now is a good time</p>",
"date_sent": "2012-02-17T06:53:00-08:00",
"message_id": "",
"message_uid": "",
"reply_to_status": false,
"total_attachments": 1,
"parent_name": "Tom Davis",
"parent_type": "Leads",
"parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6"
"team_count": "",
"team_name": [{
"id": 1,
"name": "Global",
"name_2": "",
"primary": true,
"selected": false
}], | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
46f4a5877ab1-2 | "primary": true,
"selected": false
}],
"my_favorite": false,
"_acl": {
"fields": {}
},
"_module": "Emails"
}
Updating a Draft
Request Arguments
Name
Type
Description
Required
outbound_email_id
String
The ID of the chosen SMTP configuration for sending an email. Only use this field when saving a draft
or sending an email. The user's default SMTP configuration is used if one hasn't been chosen prior to
sending.
False
name
String
The email's subject.
False
description_html
String
The email's HTML body.
False
description
String
The email's plain text body. This field is not necessary unless the text body is different from the HTML
body.
False
reply_to_id
String
Only use this field when saving a draft or sending an email that is a reply to another email. This is
the ID of that other email.
False
parent_type
String
The parent record's module.
False
parent_id
String
The parent record's ID.
False
to
Object
The email's recipients found in the TO field. Existing EmailParticipants records cannot be used; only
the create and delete actions are supported. Metadata about each recipient is required to
link the records. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
46f4a5877ab1-3 | link the records.
parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
or Users, out out of the box. These fields are not necessary if only an email address is known
for the recipient.
email_address_id is the ID of the email address the recipient used in the email. To get
the ID of the email address, first make a request to /EmailAddresses POST. If this
argument is not provided, then the primary email address of the parent record is used.
False
cc
Object
The email's recipients found in the CC field. Existing EmailParticipants records cannot be used; only
the create and delete actions are supported. Metadata about each recipient is required to
link the records.
parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
or Users, out out of the box. These fields are not necessary if only an email address is known
for the recipient.
email_address_id is the ID of the email address the recipient used in the email. To get
the ID of the email address, first make a request to /EmailAddresses POST. If this
argument is not provided, then the primary email address of the parent record is used.
False
bcc
Object
The email's recipients found in the BCC field. Existing EmailParticipants records cannot be used; only
the create and delete actions are supported. Metadata about each recipient is required to
link the records.
parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
or Users, out out of the box. These fields are not necessary if only an email address is known | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
46f4a5877ab1-4 | for the recipient.
email_address_id is the ID of the email address the recipient used in the email. To get
the ID of the email address, first make a request to /EmailAddresses POST. If this
argument is not provided, then the primary email address of the parent record is used.
False
attachments
Object
The email's attachments. Existing Notes records cannot be used as email attachments; only the
create and delete actions are supported. Metadata about each attachment is required to
link the records.
filename_guid is the temporary file ID for an uploaded file to attach as a Notes record.
upload_id is the ID of an existing file that the Notes record should reference as the
attachment. This allows files to be shared by multiple Notes records, to preserve space.
When using upload_id, file_source should be provided to indicate from where the
file originated. The value should be the module of the record that shares its ID with the file.
So when an attachment comes from an email template, file_source should be
EmailTemplates. And when an attachment comes from a document, file_source should
be DocumentRevisions.
False
Request
{
"outbound_email_id": "b80adf1a-7d78-11e7-855a-3c15c2d582c6",
"name": "Re: Discuss Proposal (new time)",
"description_html": "<p>I will call you in 10 minutes.</p>",
"parent_type": "Contacts",
"parent_id": "79b9c194-7d79-11e7-8fc5-3c15c2d582c6",
"to": { | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
46f4a5877ab1-5 | "to": {
"create": [{
"parent_type": "Contacts",
"parent_id": "79b9c194-7d79-11e7-8fc5-3c15c2d582c6"
}],
"delete": [
"ea1cec7e-7d27-11e7-9845-3c15c2d582c6"
]
},
"cc": {
"delete": [
"eafa7e9a-7d27-11e7-aa2b-3c15c2d582c6"
]
},
"attachments": {
"create": [{
"upload_id": "a028341c-ba92-9343-55e7-56cf5beda121",
"name": "Contract.pdf",
"filename": "Contract.pdf",
"file_source": "DocumentRevisions"
}],
"delete": [
"e087e79a-7d27-11e7-b02c-3c15c2d582c6"
]
}
}
Response
{
"id": "f3c85966-7d27-11e7-9e9e-3c15c2d582c6",
"date_entered": "2016-02-25T11:53:07-08:00",
"created_by": "9c61c46a-a7c5-df71-481c-51d48232f820",
"created_by_name": "Sarah Smith",
"date_modified": "2016-02-25T12:53:07-08:00", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
46f4a5877ab1-6 | "modified_by_name": "Sarah Smith",
"modified_user_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
"deleted": false,
"assigned_user_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
"assigned_user_name": "Sarah Smith",
"state": "Draft",
"outbound_email_id": "b80adf1a-7d78-11e7-855a-3c15c2d582c6",
"name": "Re: Discuss Proposal (new time)",
"description": "I will call you in 10 minutes.",
"description_html": "<p>I will call you in 10 minutes.</p>",
"date_sent": "2012-02-17T12:53:07-08:00",
"message_id": "",
"message_uid": "",
"reply_to_id": "a028341c-ba92-9343-55e7-56cf5beda121",
"reply_to_status": false,
"total_attachments": 1,
"parent_name": "Jack Horner",
"parent_type": "Contacts",
"parent_id": "79b9c194-7d79-11e7-8fc5-3c15c2d582c6"
"team_count": "",
"team_name": [{
"id": 1,
"name": "Global",
"name_2": "",
"primary": true,
"selected": false
}],
"my_favorite": false,
"_acl": { | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
46f4a5877ab1-7 | }],
"my_favorite": false,
"_acl": {
"fields": {}
},
"_module": "Emails"
}
Sending an Email
Request Arguments
Name
Type
Description
Required
state
String
Use "Ready" to send an email.
True
outbound_email_id
String
The ID of the chosen SMTP configuration for sending an email. Only use this field when saving a draft
or sending an email. The user's default SMTP configuration is used if one hasn't been chosen prior to
sending.
False
name
String
The email's subject.
False
description_html
String
The email's HTML body.
False
description
String
The email's plain text body. This field is not necessary unless the text body is different from the HTML
body.
False
reply_to_id
String
Only use this field when saving a draft or sending an email that is a reply to another email. This is
the ID of that other email.
False
parent_type
String
The parent record's module.
False
parent_id
String
The parent record's ID.
False
to
Object
The email's recipients found in the TO field. Existing EmailParticipants records cannot be used; only
the create and delete actions are supported. Metadata about each recipient is required to | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
46f4a5877ab1-8 | the create and delete actions are supported. Metadata about each recipient is required to
link the records.
parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
or Users, out out of the box. These fields are not necessary if only an email address is known
for the recipient.
email_address_id is the ID of the email address the recipient used in the email. To get
the ID of the email address, first make a request to /EmailAddresses POST. If this
argument is not provided, then the primary email address of the parent record is used.
False
cc
Object
The email's recipients found in the CC field. Existing EmailParticipants records cannot be used; only
the create and delete actions are supported. Metadata about each recipient is required to
link the records.
parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
or Users, out out of the box. These fields are not necessary if only an email address is known
for the recipient.
email_address_id is the ID of the email address the recipient used in the email. To get
the ID of the email address, first make a request to /EmailAddresses POST. If this
argument is not provided, then the primary email address of the parent record is used.
False
bcc
Object
The email's recipients found in the BCC field. Existing EmailParticipants records cannot be used; only
the create and delete actions are supported. Metadata about each recipient is required to
link the records.
parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
46f4a5877ab1-9 | parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
or Users, out out of the box. These fields are not necessary if only an email address is known
for the recipient.
email_address_id is the ID of the email address the recipient used in the email. To get
the ID of the email address, first make a request to /EmailAddresses POST. If this
argument is not provided, then the primary email address of the parent record is used.
False
attachments
Object
The email's attachments. Existing Notes records cannot be used as email attachments; only the
create and delete actions are supported. Metadata about each attachment is required to
link the records.
filename_guid is the temporary file ID for an uploaded file to attach as a Notes record.
upload_id is the ID of an existing file that the Notes record should reference as the
attachment. This allows files to be shared by multiple Notes records, to preserve space.
When using upload_id, file_source should be provided to indicate from where the
file originated. The value should be the module of the record that shares its ID with the file.
So when an attachment comes from an email template, file_source should be
EmailTemplates. And when an attachment comes from a document, file_source should
be DocumentRevisions.
False
Request
{
"state": "Ready"
}
Response
{
"id": "a7795664-7def-11e7-8add-3c15c2d582c6",
"date_entered": "2016-02-25T08:53:07-08:00", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
46f4a5877ab1-10 | "created_by": "9c61c46a-a7c5-df71-481c-51d48232f820",
"created_by_name": "Sarah Smith",
"date_modified": "2016-02-25T08:53:07-08:00",
"modified_by_name": "Sarah Smith",
"modified_user_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
"deleted": false,
"assigned_user_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
"assigned_user_name": "Sarah Smith",
"state": "Archived",
"outbound_email_id": "b80adf1a-7d78-11e7-855a-3c15c2d582c6",
"name": "Discuss Proposal",
"description": "When is a good time for us to chat?",
"description_html": "<p>When is a good time for us to chat?</p>",
"date_sent": "2012-02-17T08:53:07-08:00",
"message_id": "<[email protected]>",
"message_uid": "",
"reply_to_id": "",
"reply_to_status": false,
"total_attachments": 2,
"parent_name": "Tom Davis",
"parent_type": "Leads",
"parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6" | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
46f4a5877ab1-11 | "team_count": "",
"team_name": [{
"id": 1,
"name": "Global",
"name_2": "",
"primary": true,
"selected": false
}],
"my_favorite": false,
"_acl": {
"fields": {}
},
"_module": "Emails"
}
Change Log
Version
Change
v10
Added /Emails/: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/Emailsrecord_PUT/index.html |
be9aac1d9339-0 | /<module>/:record/audit GET
Overview
Returns data changes for a specific record.
Request Arguments
Name
Type
Description
Required
record
String
The record id.
True
module
String
The name of the module.
True
Query Parameters
Name
Type
Description
Required
max_num
Integer
A maximum number of records to return. The default is all records.
False
offset
Integer
The number of records to skip over before records are returned. The default is 0. The parameter will be ignored if the max_num parameter is missing.
False
Response Arguments
Name
Type
Description
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more records.
records
Array
An array of results containing matched records.
Response
{
"next_offset":-1,
"records":[
{
"id":"b569e480-237a-5921-4382-512ff555fee7",
"parent_id":"ef1b40aa-5815-4f8d-e909-512d09617ac8",
"date_created":"03\/01\/2013 12:26am",
"created_by":"admin",
"field_name":"Team ID:",
"data_type":"team_list",
"before_value_string":"East",
"after_value_string":"Will"
},
{
"id":"bc0bee72-8398-a0a6-d731-512ff5bfebc7",
"parent_id":"ef1b40aa-5815-4f8d-e909-512d09617ac8",
"date_created":"03\/01\/2013 12:26am",
"created_by":"admin", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordaudit_GET/index.html |
be9aac1d9339-1 | "created_by":"admin",
"field_name":"Teams",
"data_type":"id",
"before_value_string":"East, Global, West",
"after_value_string":"Jim, Will"
}
]
}
Change Log
Version
Change
v11_11
Added optional max_num and offset parameters to /Audit GET endpoint.
v10
Added /Audit 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/modulerecordaudit_GET/index.html |
b1b4b46391c4-0 | /Administration/settings/idmMode DELETE
Overview
[ADMIN] Turn IDM-mode off.
Summary
This endpoint switches IDM mode off. This is only available to administrators when IDM migration is turned on and intended for internal use for IDM integration.
Response when IDM mode has been disabled
[]
Change Log
Version
Change
v11_2
Added /Administration/settings/idmMode DELETE endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/AdministrationsettingsidmMode_DELETE/index.html |
1e1b7f19a85a-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
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 |
4ecdce4d4bc7-0 | /Employees 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
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
A maximum number of records to return. Default is 20.
False
offset
Integer | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Employees_GET/index.html |
4ecdce4d4bc7-1 | 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
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
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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Employees_GET/index.html |
4ecdce4d4bc7-2 | 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
This expression allows you to specify what operation you want to use for filtering on the field. In the example you
would match any record where the field "name" starts with the value "Nelson".
Example
{
"filter":[
{
"name":{
"$starts":"Nelson"
}
}
]
}
Below is a list of operation types:
Operation
Description
$equals
Performs an exact match on that field.
$not_equals
Performs an exact match on that field.
$not_equals
Matches on non-matching values.
$starts
Matches on anything that starts with the value.
$ends
Matches anything that ends with the value.
$contains
Matches anything that contains the value
$in
Finds anything where field matches one of the values as specified as an array.
$not_in
Finds anything where field does not matches any of the values as specified as an array.
$is_null | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Employees_GET/index.html |
4ecdce4d4bc7-3 | $is_null
Checks if the field is null. This operation does not need a value specified.
$not_null
Checks if the field is not null. This operation does not need a value specified.
$lt
Matches when the field is less than the value.
$lte
Matches when the field is less than or equal to the value.
$gt
Matches when the field is greater than the value.
$gte
Matches when the field is greater than or equal to the value.
Sub-expressions
This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.
The example expression would match if the field "name" was either "Nelson Inc" or "Nelson LLC". The only currently
accepted sub-expression types are "$and" and "$or".
Example
{
"filter":[
{
"$or":[
{
"name":"Nelson Inc"
},
{
"name":"Nelson LLC"
}
]
}
]
}
Modules
There are two module expressions, they operate on modules instead of fields. The current module can be specified by
either using the module name "_this" or by leaving the module name as a blank string. The example expression would
filter the records in the current module to only your favorites. The only currently accepted module expressions are
"$favorite" and "$owner".
Example
{
"filter":[
{
"$favorite":"_this"
}
]
}
Response Arguments
Name
Type
Description
next_offset | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Employees_GET/index.html |
4ecdce4d4bc7-4 | ]
}
Response Arguments
Name
Type
Description
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more
records.
records
Array
An array of results containing matched records.
Response
{
"next_offset":-1,
"records":[
{
"id":"fa300a0e-0ad1-b322-9601-512d0983c19a",
"name":"Dale Spivey",
"date_modified":"2013-02-28T05:03:00+00:00",
"description":"",
"opportunities": [
{
_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": [
{
_module: "Opportunities" | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Employees_GET/index.html |
4ecdce4d4bc7-5 | {
_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/Employees_GET/index.html |
fcaf67f35d55-0 | /Administration/elasticsearch/indices GET
Overview
[ADMIN] Elasticsearch index statistics
Summary
This endpoint returns the index statistics for the Elasticsearch backend. This endpoint is only available to
administrators.
Response
{
"autobr2583_shared":{
"_shards":{
"total":1,
"successful":1,
"failed":0
},
"indices":{
"autobr2583_shared":{
"index":{
"primary_size_in_bytes":1134148,
"size_in_bytes":1134148
},
"translog":{
"operations":1100
},
"docs":{
"num_docs":1100,
"max_doc":1100,
"deleted_docs":0
},
"merges":{
"current":0,
"current_docs":0,
"current_size_in_bytes":0,
"total":1,
"total_time_in_millis":103,
"total_docs":1000,
"total_size_in_bytes":1138070
},
"refresh":{
"total":13,
"total_time_in_millis":177
},
"flush":{
"total":0,
"total_time_in_millis":0
},
"shards":[[{
"routing":{
"state":"STARTED",
"primary":true,
"node":"4rjVEVuYQQqKl4sT1FUxNA",
"relocating_node":null,
"shard":0,
"index":"autobr2583_shared"
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationelasticsearchindices_GET/index.html |
fcaf67f35d55-1 | "index":"autobr2583_shared"
},
"state":"STARTED",
"index":{
"size_in_bytes":1134148
},
"translog":{
"id":1427003304006,
"operations":1100
},
"docs":{
"num_docs":1100,
"max_doc":1100,
"deleted_docs":0
},
"merges":{
"current":0,
"current_docs":0,
"current_size_in_bytes":0,
"total":1,
"total_time_in_millis":103,
"total_docs":1000,
"total_size_in_bytes":1138070
},
"refresh":{
"total":13,
"total_time_in_millis":177
},
"flush":{
"total":0,
"total_time_in_millis":0
}
}]]
}
}
}
}
Change Log
Version
Change
v10
Added /Administration/elasticsearch/indices 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/Administrationelasticsearchindices_GET/index.html |
8bbf0336f289-0 | /help GET
Overview
Fetches the help documentation
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
<html>
String
Returns the html of the help doc
Response
The HTML for this help document.
Change Log
Version
Change
v10
Added /help 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/help_GET/index.html |
6b1b693969d4-0 | /ExpressionEngine/:record/related POST
Retrieve a Forecasting Information In SugarChart Format
Summary:
This endpoint is used to return the json Data for SugarCharts to use to display the needed chart.
Query Parameters:
Param
Description
Optional
timeperiod_id
Show for a specific time period
Â
user_id
Show for a specific user
Â
display_manager
Pipeline or Committed are valid values.
Â
dataset
Which Forecast dataset to show, valid values are likely, best, worst. Defaults to likely if one is not specified
Optional
group_by
Show Which fields the y-axis shows on the chart. Can be any field in the opportunity module, defaults to Sales Stage
Optional
ranges
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",
"#000087",
"#e48d30",
"#9fba09",
"#560066",
"#009f92",
"#b36262",
"#38795c",
"#3D3D99",
"#99623d", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ExpressionEnginerecordrelated_POST/index.html |
6b1b693969d4-1 | "#3D3D99",
"#99623d",
"#998a3d",
"#994e78",
"#3d6899",
"#CC0000",
"#00CC00",
"#0000CC",
"#cc5200",
"#ccaa00",
"#6600cc",
"#005fcc"
],
"label" : [ "Include" ],
"properties" : [ { "gauge_target_list" : "Array",
"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",
"36000.00"
],
"goalmarkervaluelabel" : [ "$111,000.00",
"$36,000.00"
],
"gvalue" : 36000,
"gvaluelabel" : "$36,000.00",
"label" : "January 2013",
"links" : [ "" ], | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ExpressionEnginerecordrelated_POST/index.html |
6b1b693969d4-2 | "links" : [ "" ],
"valuelabels" : [ "$36,000.00" ],
"values" : [ 36000 ]
},
{ "goalmarkervalue" : [ "111000.00",
"61500.00"
],
"goalmarkervaluelabel" : [ "$111,000.00",
"$61,500.00"
],
"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" ],
"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 |
df2177ab91c7-0 | /ExpressionEngine/:record/related GET
Retrieve a Forecasting Information In SugarChart Format
Summary:
This endpoint is used to return the json Data for SugarCharts to use to display the needed chart.
Query Parameters:
Param
Description
Optional
timeperiod_id
Show for a specific time period
Â
user_id
Show for a specific user
Â
display_manager
Pipeline or Committed are valid values.
Â
dataset
Which Forecast dataset to show, valid values are likely, best, worst. Defaults to likely if one is not specified
Optional
group_by
Show Which fields the y-axis shows on the chart. Can be any field in the opportunity module, defaults to Sales Stage
Optional
ranges
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",
"#000087",
"#e48d30",
"#9fba09",
"#560066",
"#009f92",
"#b36262",
"#38795c",
"#3D3D99",
"#99623d", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ExpressionEnginerecordrelated_GET/index.html |
df2177ab91c7-1 | "#3D3D99",
"#99623d",
"#998a3d",
"#994e78",
"#3d6899",
"#CC0000",
"#00CC00",
"#0000CC",
"#cc5200",
"#ccaa00",
"#6600cc",
"#005fcc"
],
"label" : [ "Include" ],
"properties" : [ { "gauge_target_list" : "Array",
"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",
"36000.00"
],
"goalmarkervaluelabel" : [ "$111,000.00",
"$36,000.00"
],
"gvalue" : 36000,
"gvaluelabel" : "$36,000.00",
"label" : "January 2013",
"links" : [ "" ], | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ExpressionEnginerecordrelated_GET/index.html |
df2177ab91c7-2 | "links" : [ "" ],
"valuelabels" : [ "$36,000.00" ],
"values" : [ 36000 ]
},
{ "goalmarkervalue" : [ "111000.00",
"61500.00"
],
"goalmarkervaluelabel" : [ "$111,000.00",
"$61,500.00"
],
"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" ],
"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_GET/index.html |
d6147d24440c-0 | /pmse_Inbox/filter GET
Overview
Returns a list of Processes by user
Summary
This endpoint gets a list of processes by user
Request Arguments
Name
Type
Description
Required
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.
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
filter
string
The filter expression
false
filter_id
string
Identifier for a preexisting filter. If filter is also set, the two filters are joined with an AND
false
max_num
integer
A maximum number of records to return. Default is 20.
false
offset
integer
The number of records to skip over before records are returned. Default is 0.
false
fields
string
Comma delimited list of fields to return
false
deleted
boolean
Boolean to show deleted records in the result set.
false
Response Arguments
Name
Type
Description
records
<field>:<value>
Process records
next_offset
integer
Next offset for results
Response
{
"next_offset":-1,
"records":
[
{
"id":"839ccd22-2925-11e6-83f3-6c4008960436",
"date_modified":"2016-06-02T17:52:55-07:00",
"created_by":"1",
"cas_finish_date":"",
"assigned_user_id":"1",
"assigned_user_name":"Administrator",
"assigned_user_link":
{
"full_name":"Administrator",
"id":"1",
"_acl":
{
"fields": | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxfilter_GET/index.html |
d6147d24440c-1 | "id":"1",
"_acl":
{
"fields":
{
"pwd_last_changed":
{
"write":"no",
"create":"no"
},
"last_login":
{
"write":"no",
"create":"no"
}
},
"delete":"no",
"_hash":"08b99a97c2e8d792f7a44d8882b5af6d"
}
},
"_acl":
{
"fields":{}
},
"_module":"pmse_Project\/pmse_BpmFlow",
"_locked_fields":[],
"cas_id":"4",
"act_assignment_method":"static",
"cas_title":"PQR1",
"pro_title":"PD1",
"date_entered":"2016-06-02T17:52:55-07:00",
"name":"PQR1",
"cas_create_date":"2016-06-02T17:52:55-07:00",
"flow_id":"839ccd22-2925-11e6-83f3-6c4008960436",
"id2":"8380e512-2925-11e6-9600-6c4008960436",
"task_name":"Activity # 1",
"cas_assignment_method":"static",
"cas_sugar_module":"Accounts",
"cas_sugar_object_id":"82d5c470-2925-11e6-a269-6c4008960436",
"prj_id":"6e025038-2842-11e6-b4f7-6c4008960436", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxfilter_GET/index.html |
d6147d24440c-2 | "in_time":true,
"cas_user_id":"1",
"prj_created_by":"1",
"cas_user_id_full_name":"Administrator",
"prj_user_id_full_name":"Administrator"
},
]
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxfilter_GET/index.html |
b6232c171bf0-0 | /Documents/:record/file/:field POST
Overview
Attaches a file to a field on a record.
Request Arguments
Name
Type
Description
Required
format
String
The data format. Currently accepts 'sugar-html-json'.
True
delete_if_fails
Boolean
Indicates whether the API is to mark related record deleted if the file upload fails.
False
oauth_token
String
The oauth_token value.
False - Required if only if delete_if_fails is true.
<attachment field>
String
The field and file to populate.
Example: {"":"@\/path\/to\/ExampleDocument.txt"}
True
Request
{
"format":"sugar-html-json",
"delete_if_fails":true,
"oauth_token":"43b6b327-cc70-c301-3299-512ffb99ad97",
"<attachment field>":"@\/path\/to\/ExampleDocument.txt"
}
Response Arguments
Name
Type
Description
content-type
String
The files content type.
content-length
Integer
The files content length.
name
String
The files name.
uri
String
The URI of the file.
Response
{
"content-type":"text\/plain",
"content-length":16,
"name":"ExampleDocument.txt", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Documentsrecordfilefield_POST/index.html |
b6232c171bf0-1 | "content-length":16,
"name":"ExampleDocument.txt",
"uri":"http:\/\/sugarcrm\/rest\/v10\/Notes\/ca66c92f-5a8b-28b4-4fc8-512d099b790b\/file\/<attachment field>?format=sugar-html-json&delete_if_fails=1&oauth_token=6ec91cf3-1f97-25b9-e0b1-512f8971b2d4"
}
Change Log
Version
Change
v10
Added /<module>/:record/file/:field POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Documentsrecordfilefield_POST/index.html |
1d2ade7434cf-0 | /Meetings/:record PUT
Overview
Update a calendar event record of the specified type.
Request Arguments
Name
Type
Description
Required
all_recurrences
Boolean
Flag to update all events in a series.
False
Request
http://{site_url}/rest/v10/Meetings/2c9e5c09-6824-0d14-f5cb-5130321ac3cf?all_recurrences=true
{
"name":"Department Meeting",
"description":"Weekly Department Meeting",
"date_start":"yyyy-mm-ddThh:mm:ss-00:00",
"date_end":"yyyy-mm-ddThh:mm:ss-00:00",
"repeat_type":"Weekly",
"repeat_interval":"1", /* Every Week */
"repeat_dow":"25", /* Tue and Fri */
"repeat_count":"4", /* 4 Recurrences */
"repeat_until":"",
}
Response Arguments
Name
Description
Start Date
End Date
<record field>
Returns the fields for the updated record.
Response
{
}
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/Meetingsrecord_PUT/index.html |
0bff206380d4-0 | /<module>/sync_key/:sync_key_field_value GET
Overview
Retrieves the record with the given sync_key.
Request Arguments
Name
Type
Description
Required
module
String
The module the record belongs to
True
sync_key_field_value
String
A unique ID for the record identifying it in an external system
True
Request
/<module>/sync_key/:sync_key_field_value
Response Arguments
Body: formatted JSON object.
Response
Successful Response
Status 200
Failed Response
Status 422
{
"error": "invalid_parameter",
"error_message": "Could not find record with :sync_key_field_value in module: <module>"
}
Change Log
Version
Change
v11_10
Added /<module>/sync_key/:sync_key_field_value GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulesync_keysync_key_field_value_GET/index.html |
97a50f4f0380-0 | /KBContents/:record/notuseful PUT
Overview
Vote for Knowledge Base article.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
<record field>
<record field type>
Returns the fields for the updated record.
Response
{
"active_date": "2014-01-01",
"active_rev": 1,
"approved": false,
"assigned_user_id": "seed_will_id",
"assigned_user_link": {"full_name": "Will Westin", "id": "seed_will_id"},
"assigned_user_name": "Will Westin",
"attachment_list": [],
"cases": {"name": "", "id": ""},
"category_id": "3e844f1c-5ce1-6d6d-496d-5714901e6666",
"category_name": "Database",
"created_by": "1",
"created_by_link": {"full_name": "Administrator", "id": "1"},
"created_by_name": "Administrator",
"date_entered": "2016-04-18T07:43:43+00:00",
"date_modified": "2016-04-18T07:43:43+00:00",
"deleted": false,
"description": "",
"exp_date": "2014-12-31",
"file_mime_type": "",
"following": false,
"id": "87758ab5-75eb-451f-2bd7-571490d29d7a",
"is_external": false, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordnotuseful_PUT/index.html |
97a50f4f0380-1 | "is_external": false,
"kbarticle_id": "8862943c-022e-0385-908e-5714908ac792",
"kbarticle_name": "Resetting the device",
"kbarticles_kbcontents": {"name": "Resetting the device", "id": "8862943c-022e-0385-908e-5714908ac792"},
"kbdocument_body": "When things are not working as expected...",
"kbdocument_id": "87a20b6b-3172-ad19-0ca5-571490bec118",
"kbdocument_name": "Resetting the device",
"kbdocuments_kbcontents": {"name": "Resetting the device", "id": "87a20b6b-3172-ad19-0ca5-571490bec118"},
"kbsapprover_id": "",
"kbsapprover_name": "",
"kbsapprovers_kbcontents": {"full_name": "", "id": ""},
"kbscase_id": "",
"kbscase_name": "",
"language": "en",
"modified_by_name": "Administrator",
"modified_user_id": "1",
"modified_user_link": {"full_name": "Administrator", "id": "1"},
"my_favorite": false,
"name": "Resetting the device",
"notuseful": 1
"related_languages": ["en"],
"revision": 1
"status": "in-review",
"tag": [],
"team_count": "",
"team_count_link": {"team_count": "", "id": "1"}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordnotuseful_PUT/index.html |
97a50f4f0380-2 | "team_count_link": {"team_count": "", "id": "1"},
"team_name": [{"id": 1, "name": "Global", "name_2": "", "primary": true}],
"useful": 0,
"usefulness_user_vote": "-1",
"viewcount": 4
}
Change Log
Version
Change
v10
Added /KBContents/:record/useful PUT endpoint.
v10
Added /KBContents/:record/notuseful PUT endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordnotuseful_PUT/index.html |
224c31c73e39-0 | /integrate/<module>/:lhs_sync_key_field_name/:lhs_sync_key_field_value/link/:link_name/:rhs_sync_key_field_name/:rhs_sync_key_field_value POST
Overview
Creates a relationship based on lhs_sync_key_field_name and rhs_sync_key_field_name. If both the LHS and RHS records can be found with the respective fields, then relate the RHS record to the LHS record.
Request Arguments
Name
Type
Description
Required
module
String
The module the record belongs to
True
lhs_sync_key_field_name
String
The name of the LHS field that contains lhs_sync_key_field_value (the default field is named sync_key but can be renamed via code customization)
True
lhs_sync_key_field_value
String
A unique ID for the LHS record identifying it in an external system
True
link_name
String
A name for the link
True
rhs_sync_key_field_name
String
The name of the RHS field that contains rhs_sync_key_field_value (the default field is named sync_key but can be renamed via code customization)
True
rhs_sync_key_field_value
String
A unique ID for the RHS record identifying it in an external system
True
Request
/integrate/<module>/:lhs_sync_key_field_name/:lhs_sync_key_field_value/link/:link_name/:rhs_sync_key_field_name/:rhs_sync_key_field_value
Response Arguments
Name
Type
Description
record
String
The ID of the record.
related_record
String
The ID of the related record.
Response
Status 200
{
"record": "a0328573-a252-a27c-3530-4e4297d4c9e1",
"related_record": "a0328573-bc54-a554-3530-4e4297d4c9e1"
}
Status 422
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Integratemodulelhs_sync_key_field_namelhs_sync_key_field_valuelinklink_namerhs_sync_key_field_namerhs_sync_key_field_value_POST/index.html |
224c31c73e39-1 | }
Status 422
{
"error": "invalid_parameter",
"error_message": "Could not find record with :xhs_sync_key_field_name::xhs_sync_key_field_value in module: <module>"
}
Change Log
Version
Change
v11_10
Added /integrate/<module>/:lhs_sync_key_field_name/:lhs_sync_key_field_value/link/:link_name/:rhs_sync_key_field_name/:rhs_sync_key_field_value 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/Integratemodulelhs_sync_key_field_namelhs_sync_key_field_valuelinklink_namerhs_sync_key_field_namerhs_sync_key_field_value_POST/index.html |
54c5e31f05ed-0 | /me/preference/:preference_name PUT
Overview
Updates a specific preference for the current user.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
Â
Â
Â
Response
{
}
Change Log
Version
Change
v10
Added /me/preference/:preference_name 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/mepreferencepreference_name_PUT/index.html |
ccda56fec1e0-0 | /<module>/record_list/:record_list_id DELETE
Overview
An API to delete lists of records
Summary
Delete record list. Only DELETE request allowed.
Request Arguments
Name
Type
Description
Required
module
string
Module name
True
record_list_id
guid
record list id
True
Request Example
DELETE /rest/v10/:module/record_list/:id
Response Arguments
Return boolean 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/modulerecord_listrecord_list_id_DELETE/index.html |
c596b12dc46b-0 | /<module>/filter GET
Overview
Lists filtered records.
Summary
This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields
and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.
If both a filter definition and a filter id are passed, the two filters will be joined with an AND.
Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise
the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:
"link_name.remote_field", so if you wished to search the Accounts module by a related member account you would
use "members.sic_code".
Request Arguments
Name
Type
Description
Required
filter
String
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
A maximum number of records to return. Default is 20.
False
offset
Integer | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_GET/index.html |
c596b12dc46b-1 | 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
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
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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_GET/index.html |
c596b12dc46b-2 | 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
This expression allows you to specify what operation you want to use for filtering on the field. In the example you
would match any record where the field "name" starts with the value "Nelson".
Example
{
"filter":[
{
"name":{
"$starts":"Nelson"
}
}
]
}
Below is a list of operation types:
Operation
Description
$equals
Performs an exact match on that field.
$not_equals
Performs an exact match on that field.
$not_equals
Matches on non-matching values.
$starts
Matches on anything that starts with the value.
$ends
Matches anything that ends with the value.
$contains
Matches anything that contains the value
$in
Finds anything where field matches one of the values as specified as an array.
$not_in
Finds anything where field does not matches any of the values as specified as an array.
$is_null | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_GET/index.html |
c596b12dc46b-3 | $is_null
Checks if the field is null. This operation does not need a value specified.
$not_null
Checks if the field is not null. This operation does not need a value specified.
$lt
Matches when the field is less than the value.
$lte
Matches when the field is less than or equal to the value.
$gt
Matches when the field is greater than the value.
$gte
Matches when the field is greater than or equal to the value.
Sub-expressions
This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.
The example expression would match if the field "name" was either "Nelson Inc" or "Nelson LLC". The only currently
accepted sub-expression types are "$and" and "$or".
Example
{
"filter":[
{
"$or":[
{
"name":"Nelson Inc"
},
{
"name":"Nelson LLC"
}
]
}
]
}
Modules
There are two module expressions, they operate on modules instead of fields. The current module can be specified by
either using the module name "_this" or by leaving the module name as a blank string. The example expression would
filter the records in the current module to only your favorites. The only currently accepted module expressions are
"$favorite" and "$owner".
Example
{
"filter":[
{
"$favorite":"_this"
}
]
}
Response Arguments
Name
Type
Description
next_offset | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_GET/index.html |
c596b12dc46b-4 | ]
}
Response Arguments
Name
Type
Description
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more
records.
records
Array
An array of results containing matched records.
Response
{
"next_offset":-1,
"records":[
{
"id":"fa300a0e-0ad1-b322-9601-512d0983c19a",
"name":"Dale Spivey",
"date_modified":"2013-02-28T05:03:00+00:00",
"description":"",
"opportunities": [
{
_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": [
{
_module: "Opportunities" | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_GET/index.html |
c596b12dc46b-5 | {
_module: "Opportunities"
date_modified: "2014-09-08T16:05:00+03:00"
id: "9ce7c088-8ee4-7cd3-18f1-540da944d4c0"
name: "360 Vacations - 312 Units"
sales_status: "New"
},
],
"_acl": {
"fields": {
}
}
}
]
}
Change Log
Version
Change
v10
Added /<module>/filter GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_GET/index.html |
2c2a688cd8ef-0 | /pmse_Project/:record/verify GET
Overview
Verifies whether the Process Definition has any pending processes
Summary
This endpoint will verify whether the Process Definition identified by the
record input parameter has any currently pending processes
based on it.
Request Arguments
Name
Type
Description
Required
record
String
The Process Definition record ID
True
Response Arguments
Name
Type
Description
N/A
Response
Note: The response is a string of either "true" or "false"
indicating whether any pending processes exist.
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_Projectrecordverify_GET/index.html |
9c846e44aead-0 | /Calls/:record DELETE
Overview
Deletes either a single event record or a series of event records
Request Arguments
Name
Type
Description
Required
all_recurrences
Boolean
Flag to delete all events in a series.
False
Request
http://{site_url}/rest/v10/Meetings/2c9e5c09-6824-0d14-f5cb-5130321ac3cf?all_recurrences=true
Response Arguments
Name
Type
Description
id
String
Returns the ID of the deleted record.
Response
{
"id": "11cf0d0a-40af-8cb1-9da0-5057a5f511f9"
}
Change Log
Version
Change
v10
Added /<module>/:record DELETE endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Callsrecord_DELETE/index.html |
163cd95ad413-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
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
}
],
"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 |
934f34b1aa79-0 | /Mail/archive POST
Overview
Archives an email.
Query String Parameters
This endpoint does not accept any query string parameters.
Input Parameters
Name
Type
Description
Required
date_sent
String
Date of email sent
True
from_address
String
From email address
True
to_addresses
Array
Array of name/email address pairs for the TO field, when present, only email subfield is required (not name).
True
cc_addresses
Array
Array of name/email address pairs for the CC field, when present, email subfield is required.
False
bcc_addresses
Array
Array of name/email address pairs for the BCC field, when present, email subfield is required.
False
subject
String
Subject of the email
True
html_body
String
HTML body of the email
False
text_body
String
Text body of the email
False
status
String
Indicates the status of the email - 'draft' or 'ready' (ready to be sent)
True
related
Object
Contains 'parent_type' and 'parent_id' to relate this email to (for example 'Contact' and a contact's id)
False
teams
Object | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailarchive_POST/index.html |
934f34b1aa79-1 | False
teams
Object
Team(s) to assign this email to. 'primary' attribute is an id string for the primary team and 'other' attribute is an array of id strings for the other teams - only primary is required
True
assigned_user_id
String
ID of a user this record is assigned to.
False
attachments
Array
Array of file attachments - each attachment consists of a 'type' (where the attachment came from: upload, document, or template), 'id' (of the file upload, note, document revision, etc), and 'name' (the file name)
False
Input Example
{
"date_sent":"2014-02-07T00:00:00",
"from_address":"[email protected]"
"to_addresses":[
{
"name":"John Doe",
"email":"[email protected]",
"module":"Leads"
},
{
"name":"David Madison",
"email":"[email protected]",
"module":"Leads"
}
],
"cc_addresses":[
{
"name":"Tom Swift",
"email":"[email protected]"
}
],
"bcc_addresses":null,
"subject":"Minneapolis Convention",
"html_body":"<html><body>Hello World<\/body><\/html>",
"text_body":"Hello World"
"status":"archive",
"related": {
"type":"Contacts", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailarchive_POST/index.html |
934f34b1aa79-2 | "status":"archive",
"related": {
"type":"Contacts",
"id":"61cf0f8d-938c-c9b2-53ad-51ed7bbcf83b"
},
"teams": {
"primary": "dabec868-696c-f458-e204-50227995ab50",
"others": [
"c3094c88-c95f-2e17-4553-50227996ad20",
"abcde868-696c-f458-e704-58369095ab62"
]
},
"assigned_user_id":"seed_jim_id",
"attachments": [
{
"type": "upload",
"id": "cfbe4551-548d-f602-b228-45387645fc12",
"name": "company_logo.jpg"
},
{
"type": "document",
"id": "876112a4-89c1-4ba7-a05a-7729a7a76818"
},
{
"type": "template",
"id": "002cfe6c-98e9-4342-bdb1-1660d0788872"
}
],
}
Result
Name
Type
Description
<email record field>
<email record field type>
Returns the fields for the newly created email record.
Output Example
{
"team_id": "9c61c46a-a7c5-df71-481c-51d48232f820", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailarchive_POST/index.html |
934f34b1aa79-3 | "team_set_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
"id": "d9c165d0-8863-ba61-dc85-51ed8016c476",
"date_entered": "2013-07-22 18:57:57",
"date_modified": "2013-07-22 18:57:57",
"assigned_user_id": "1",
"assigned_user_name": "",
"modified_user_id": "1",
"modified_by_name": "admin",
"created_by": "1",
"created_by_name": "",
"deleted": 0,
"from_addr_name": "SugarCRM",
"reply_to_addr": "",
"to_addrs_names": "[email protected], [email protected]",
"cc_addrs_names": "[email protected]",
"description_html": "<html><body>Hello World<\/body><\/html>",
"description": "Hello World",
"date_sent": "2013-07-22 18:57:00",
"name": "Minneapolis Convention",
"type": "out",
"status": "sent",
"parent_type": "Contacts",
"parent_id": "61cf0f8d-938c-c9b2-53ad-51ed7bbcf83b",
"from_address":"[email protected]"
}
Change Log
Version
Change
v11
Last version in which /Mail/archive POST is available. Use /Emails POST with
{"state": "Archived"} instead.
v10 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailarchive_POST/index.html |
934f34b1aa79-4 | {"state": "Archived"} instead.
v10
Added /Mail/archive POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailarchive_POST/index.html |
b653e5d56bfe-0 | /Administration/elasticsearch/refresh/trigger POST
Overview
[ADMIN] Elasticsearch trigger explicit index refresh on all indices
Summary
Trigger an explicit index refresh for all indices managed by SugarCRM. This endpoint is only
available to administrators.
Response
{
"aabbcc_contactsleads": 200,
"aabbcc_accountsonly": 200,
"aabbcc_shared": 200
}
Change Log
Version
Change
v10
Added /Administration/elasticsearch/refresh/trigger 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/Administrationelasticsearchrefreshtrigger_POST/index.html |
76e8363db03c-0 | /<module>/recent-product POST
Overview
Opportunity Recent Product Help
Summary
This endpoint retrieves top 10 recently used Quoted/Revenue Line Items based on the module to display them in the
"Product Catalog Quick Picks" dashlet in the reverse chronological order.
Request Arguments
None
Response Arguments
NONE
Response
{
"next_offset":-1,
"records":[
{
"id":"c1b4680e-c7f2-11e8-9380-7831c1c14620",
"name":"Brain Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c1b3bf58-c7f2-11e8-92e7-7831c1c14620",
"mft_part_num":"Smallville Resources Inc 362299XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"370.000000",
"discount_price":"854.370000",
"list_price":"863.000000",
"cost_usdollar":"370.000000",
"discount_usdollar":"854.370000",
"list_usdollar":"863.000000",
"status":"Available",
"tax_class":"Taxable", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_POST/index.html |
76e8363db03c-1 | "status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"10.00",
"qty_in_stock":106,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"PercentageDiscount",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"Base_rate":"1.000000"
},
{
"id":"c186a612-c7f2-11e8-9fee-7831c1c14620",
"name":"Bradford Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c185dbb0-c7f2-11e8-a6b7-7831c1c14620",
"mft_part_num":"Mississippi Bank Group 133834XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"528.000000",
"discount_price":"533.333333",
"list_price":"745.000000", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_POST/index.html |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.