id
stringlengths 14
16
| text
stringlengths 33
5.27k
| source
stringlengths 105
270
|
|---|---|---|
e7a11cf48097-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
|
dc6dce96fce0-0
|
/Administration/aws GET
Overview
[ADMIN] Gets Amazon Web Services configs from Sugar Serve.
Summary
This endpoint gets configuration values for Amazon Web Services. This endpoint is only available to administrators of Sugar Serve.
Request Arguments
This endpoint does not accept any arguments.
Response
{
"aws_connect_instance_name": "my-aws-instance",
"aws_connect_region": "us-east-2"
}
Change Log
Version
Change
v11_10
Added /Administration/aws 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/Administrationaws_GET/index.html
|
b88f908754ab-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
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxfilter_GET/index.html
|
b88f908754ab-1
|
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",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxfilter_GET/index.html
|
b88f908754ab-2
|
"assigned_user_id":"1",
"assigned_user_name":"Administrator",
"assigned_user_link":
{
"full_name":"Administrator",
"id":"1",
"_acl":
{
"fields":
{
"pwd_last_changed":
{
"write":"no",
"create":"no"
},
"last_login":
{
"write":"no",
"create":"no"
}
},
"delete":"no",
"_hash":"08b99a97c2e8d792f7a44d8882b5af6d"
}
},
"_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
|
b88f908754ab-3
|
"_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",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxfilter_GET/index.html
|
b88f908754ab-4
|
"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",
"in_time":true,
"cas_user_id":"1",
"prj_created_by":"1",
"cas_user_id_full_name":"Administrator",
"prj_user_id_full_name":"Administrator"
},
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxfilter_GET/index.html
|
b88f908754ab-5
|
"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
|
014041c40b2f-0
|
/<module>/append/:target POST
Overview
Append new node to target node as last child.
Request Arguments
Name
Type
Description
Required
module
String
The name of sugar module that contains a nested set data and implements the NestedSetInterface.
True
target
String
The ID of record that will be used as target to append new node
True
Request
{
"name" : "Children Node 1"
}
Response Arguments
This endpoint does not return any response arguments.
Response
This endpoint returns a newly created bean
{
"my_favorite":false,
"following":"",
"id":"59fa8dd7-0f2c-4bfd-364f-54495f77fa3f",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleappendtarget_POST/index.html
|
014041c40b2f-1
|
"name":"Default title",
"date_entered":"2014-10-23T23:03:22+03:00",
"date_modified":"2014-10-23T23:03:22+03:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"doc_owner":"",
"description":"",
"deleted":false,
"source_id":"",
"source_type":"",
"source_meta":"",
"root":"be9b0c4a-8b78-1ffa-4f14-54481c2f6269",
"lft":118,
"rgt":119,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleappendtarget_POST/index.html
|
014041c40b2f-2
|
"lft":118,
"rgt":119,
"level":1,
"_acl":{"fields":{}},
"_module":"Categories"
}
Change Log
Version
Change
v10
Added /<module>/append/:target POST endpoint.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleappendtarget_POST/index.html
|
205ede9ec516-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
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationelasticsearchindices_GET/index.html
|
205ede9ec516-1
|
"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,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationelasticsearchindices_GET/index.html
|
205ede9ec516-2
|
"state":"STARTED",
"primary":true,
"node":"4rjVEVuYQQqKl4sT1FUxNA",
"relocating_node":null,
"shard":0,
"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,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationelasticsearchindices_GET/index.html
|
205ede9ec516-3
|
"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
|
f80c55768d32-0
|
/<module> POST
Overview
Create a new record of a specified type.
Request Arguments
Name
Type
Description
Required
<record field>
<record field type>
The name value list of fields to populate.
True
Request
{
"name":"Example Account",
"account_type":"Customer",
"description":"My Example Account",
"meetings": {
{
"add": ["21e3385e-404f-b470-407e-54044e3d8023"],
"create": [
{
"name": "Test Meeting"
}
]
}
}
}
Link fields
It is possible to add record relations to other records and create new related records.
Action
Type
Description
add
List
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_POST/index.html
|
f80c55768d32-1
|
Action
Type
Description
add
List
List of related records ID. See RelateRecordApi
for details.
create
List
List of name to value arrays of related records.
Response Arguments
Name
Type
Description
<record field>
<record field type>
Returns the fields for the newly created record.
Response
{
"id":"e91b1fa7-1bd8-3c71-be96-512e643f9ca4",
"name":"Example Account",
"date_entered":"2013-02-27T19:56:00+00:00",
"date_modified":"2013-02-27T19:56:00+00:00",
"modified_user_id":"1",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_POST/index.html
|
f80c55768d32-2
|
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"My Example Account",
"img":"",
"deleted":false,
"assigned_user_id":"",
"assigned_user_name":"",
"team_name":[
{
"id":1,
"name":"Global",
"name_2":"",
"primary":true
}
],
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"account_type":"Customer",
"industry":"",
"annual_revenue":"",
"phone_fax":"",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_POST/index.html
|
f80c55768d32-3
|
"annual_revenue":"",
"phone_fax":"",
"billing_address_street":"",
"billing_address_street_2":"",
"billing_address_street_3":"",
"billing_address_street_4":"",
"billing_address_city":"",
"billing_address_state":"",
"billing_address_postalcode":"",
"billing_address_country":"",
"rating":"",
"phone_office":"",
"phone_alternate":"",
"website":"",
"ownership":"",
"employees":"",
"ticker_symbol":"",
"shipping_address_street":"",
"shipping_address_street_2":"",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_POST/index.html
|
f80c55768d32-4
|
"shipping_address_street_2":"",
"shipping_address_street_3":"",
"shipping_address_street_4":"",
"shipping_address_city":"",
"shipping_address_state":"",
"shipping_address_postalcode":"",
"shipping_address_country":"",
"email1":"",
"parent_id":"",
"sic_code":"",
"parent_name":"",
"email_opt_out":"",
"invalid_email":"",
"email":[
],
"campaign_id":"",
"campaign_name":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
}
Change Log
Version
Change
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_POST/index.html
|
f80c55768d32-5
|
}
}
}
Change Log
Version
Change
v10 (7.6.0)
Added support for link fields.
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/module_POST/index.html
|
5d46a28343cb-0
|
/<module>/Activities GET
Activities on a module's list view
Summary:
This endpoint lists activities across a particular module in the system. It uses a subscription model, and can be queried like a normal bean collection, but without search, ordering or filtering.
Query Parameters:
ParamDescriptionOptionalmax_numA maximum number of records to returnOptionaloffsetHow many records to skip over before records are returnedOptional
Input Example:
This endpoint does not accept any input
Output Example:
{
"next_offset": 20, This will be set to -1 when there are no more records after this "page".
"records": [{
"id": "22fb8b16-de1d-f1dc-b15b-51240efde177",
"date_entered": "2013-02-19T23:47:11+00:00",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleActivities_GET/index.html
|
5d46a28343cb-1
|
"date_modified": "2013-02-19T23:47:11+00:00",
"created_by": "1",
"deleted": "0",
"parent_id": "f5bb0331-2c0f-5c7c-b4db-5123caac0056",
"parent_type": "Contacts",
"activity_type": "post", This will be the type of activity performed.
"data": {
"value": "This is a test post on a contact I'm subscribed to."
},
"comment_count": 0, This will be set to the total number of comments on the post.
"last_comment": { This will be the last comment on the post, which can be used to create a comment model on the frontend.
"deleted": 0,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleActivities_GET/index.html
|
5d46a28343cb-2
|
"deleted": 0,
"data": []
},
"fields": [],
"first_name": null,
"last_name": "Administrator",
"created_by_name": " Administrator" This will be the locale-formatted full name of the user.
}, ... ]
}
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleActivities_GET/index.html
|
4e30aaa863b6-0
|
/Administration/elasticsearch/replicas/status GET
Overview
[ADMIN] Elasticsearch index replica status
Summary
This endpoint returns the number of replicas for every index managed by SugarCRM. This endpoint is only
available to administrators.
Response
{
"aabbcc_contactsleads": "4",
"aabbcc_accountsonly": "2",
"aabbcc_shared": "1"
}
Change Log
Version
Change
v10
Added /Administration/elasticsearch/replicas/status 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/Administrationelasticsearchreplicasstatus_GET/index.html
|
ca3cee881efe-0
|
/Administration/portalmodules GET
Overview
[ADMIN] Gets an array of modules currently enabled for Sugar Portal.
Summary
This endpoint gets an array of modules currently enabled for Sugar Portal. This endpoint is only available to administrators.
Request Arguments
This endpoint does not accept any arguments.
Response Example
[
'Home',
'Bugs',
'Cases',
'KBContents',
]
Change Log
Version
Change
v11.13
Added Administration/portalmodules 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/AdministrationportalmodulesGET/index.html
|
80124cdd7193-0
|
/Reports/:record/record_count GET
Overview
An API to get total number of filtered records from a saved report.
Summary
This endpoint will return total number of records from a saved report filtered by an expression.
Request Arguments
Name
Type
Description
Required
group_filters
String
The group 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: group_filters[0][name]=value.
By specifying the whole filter as a single JSON-encoded string.
Example: group_filters=[{"name":"value"}].
Example: group_filters[0][industry]=Engineering.
False
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Reportsrecordrecord_count_GET/index.html
|
80124cdd7193-1
|
False
use_saved_filters
Boolean
Flag to indicate whether or not to apply saved runtime filters if exists. The default value is false.
Example: use_saved_filters=true.
False
Request Example
GET /rest/v10/Reports/:id/record_count?group_filters[0][industry]=Engineering
Response Arguments
Name
Type
Description
record_count
Integer
Total number of filtered records.
Response
{
"record_count": 5
}
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/Reportsrecordrecord_count_GET/index.html
|
d49cc1169547-0
|
/Emails POST
Overview
Create a new Emails record.
Summary
Used for creating an archived email, creating a draft to send later, or creating and sending an email.
Creating an Archived Email
Request Arguments
Name
Type
Description
Required
state
String
Use "Archived" to create an archived email. "Archived" is the default value if this argument is not
provided.
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
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-1
|
body.
False
raw_source
String
The complete raw source of the email showing the headers and content in one document.
False
date_sent
String
The date that the email was sent/received.
False
message_id
String
The email's unique identifier.
False
message_uid
String
Only use this field for importing emails downloaded 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
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-2
|
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
from
Object
The email's sender. Existing EmailParticipants records cannot be used; only the create action is
supported. Metadata about the sender is required to link the record.
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 sender.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-3
|
for the sender.
email_address_id is the ID of the email address the sender used to send 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.
True
to
Object
The email's recipients found in the TO field. Existing EmailParticipants records cannot be used; only
the create action is 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.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-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
cc
Object
The email's recipients found in the CC field. Existing EmailParticipants records cannot be used; only
the create action is 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.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-5
|
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 action is 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.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-6
|
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 action is 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.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-7
|
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": "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",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-8
|
"message_id": "<[email protected]>",
"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
}],
"from": {
"create": [{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-9
|
}],
"from": {
"create": [{
"parent_type": "Leads",
"parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6"
}]
},
"to": {
"create": [{
"parent_type": "Users",
"parent_id": "9c61c46a-a7c5-df71-481c-51d48232f820"
}]
},
"cc": {
"create": [{
"parent_type": "Contacts",
"parent_id": "79b9c194-7d79-11e7-8fc5-3c15c2d582c6"
}, {
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-10
|
}, {
"parent_type": "Users",
"parent_id": "79c2e800-7d79-11e7-84af-3c15c2d582c6"
"email_address_id": "79cc341e-7d79-11e7-8748-3c15c2d582c6"
}]
},
"bcc": {
"create": [{
"email_address_id": "ac804842-7d78-11e7-a809-3c15c2d582c6"
}]
},
"attachments": {
"create": [{
"filename_guid": "afe9702e-53a3-0efb-6bbe-56c3580885ef",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-11
|
"name": "Quote.pdf",
"filename": "Quote.pdf"
}]
}
}
Response
{
"id": "a028341c-ba92-9343-55e7-56cf5beda121",
"date_entered": "2016-02-25T11:53:07-08:00",
"created_by": "9c61c46a-a7c5-df71-481c-51d48232f820",
"created_by_name": "Sarah Smith",
"date_modified": "2016-02-25T11:53:07-08:00",
"modified_by_name": "Sarah Smith",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-12
|
"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": "",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-13
|
"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
}],
"my_favorite": false,
"_acl": {
"fields": {}
},
"_module": "Emails"
}
Creating a Draft
Request Arguments
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-14
|
"_module": "Emails"
}
Creating a Draft
Request Arguments
Name
Type
Description
Required
state
String
Use "Draft" to save a draft.
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
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-15
|
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
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-16
|
the create action is 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 action is 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/Emails_POST/index.html
|
d49cc1169547-17
|
the create action is 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 action is 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/Emails_POST/index.html
|
d49cc1169547-18
|
the create action is 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
attachments
Object
The email's attachments. Existing Notes records cannot be used as email attachments; only the
create action is supported. Metadata about each attachment is required to link the records.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-19
|
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": "Draft",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-20
|
False
Request
{
"state": "Draft",
"outbound_email_id": "b80adf1a-7d78-11e7-855a-3c15c2d582c6",
"name": "Re: Discuss Proposal",
"description_html": "<p>Calling you now.</p>",
"reply_to_id": "a028341c-ba92-9343-55e7-56cf5beda121",
"parent_type": "Leads",
"parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6",
"to": {
"create": [{
"parent_type": "Leads",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-21
|
"create": [{
"parent_type": "Leads",
"parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6"
}]
},
"cc": {
"create": [{
"parent_type": "Contacts",
"parent_id": "79b9c194-7d79-11e7-8fc5-3c15c2d582c6"
}, {
"parent_type": "Users",
"parent_id": "79c2e800-7d79-11e7-84af-3c15c2d582c6"
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-22
|
"email_address_id": "79cc341e-7d79-11e7-8748-3c15c2d582c6"
}]
},
"bcc": {
"create": [{
"email_address_id": "ac804842-7d78-11e7-a809-3c15c2d582c6"
}]
},
"attachments": {
"create": [{
"upload_id": "a028341c-ba92-9343-55e7-56cf5beda121",
"name": "Contract.pdf",
"filename": "Contract.pdf",
"file_source": "DocumentRevisions"
}, {
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-23
|
"file_source": "DocumentRevisions"
}, {
"upload_id": "18a72782-4514-11e6-a5f7-3c15c2d582c6",
"name": "survey.doc",
"filename": "survey.doc",
"file_source": "EmailTemplates"
}]
}
}
Response
{
"id": "f3c85966-7d27-11e7-9e9e-3c15c2d582c6",
"date_entered": "2016-02-25T11:53:07-08:00",
"created_by": "9c61c46a-a7c5-df71-481c-51d48232f820",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-24
|
"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": "Draft",
"outbound_email_id": "b80adf1a-7d78-11e7-855a-3c15c2d582c6",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-25
|
"name": "Re: Discuss Proposal",
"description": "Now is a good time",
"description_html": "<p>Now is a good time</p>",
"date_sent": "2012-02-17T11:53:07-08:00",
"message_id": "",
"message_uid": "",
"reply_to_id": "a028341c-ba92-9343-55e7-56cf5beda121",
"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/Emails_POST/index.html
|
d49cc1169547-26
|
"team_count": "",
"team_name": [{
"id": 1,
"name": "Global",
"name_2": "",
"primary": true,
"selected": false
}],
"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
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-27
|
or sending an email. The user's default SMTP configuration is used if one hasn't been chosen prior to
sending.
False
name
String
The email's subject.
False
description_html
String
The email's HTML body.
False
description
String
The email's plain text body. This field is not necessary unless the text body is different from the HTML
body.
False
reply_to_id
String
Only use this field when saving a draft or sending an email that is a reply to another email. This is
the ID of that other email.
False
parent_type
String
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-28
|
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 action is supported. Metadata about each recipient is required to link the records.
parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
or Users, out out of the box. These fields are not necessary if only an email address is known
for the recipient.
email_address_id is the ID of the email address the recipient used in the email. To get
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-29
|
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 action is supported. Metadata about each recipient is required to link the records.
parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
or Users, out out of the box. These fields are not necessary if only an email address is known
for the recipient.
email_address_id is the ID of the email address the recipient used in the email. To get
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-30
|
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 action is supported. Metadata about each recipient is required to link the records.
parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
or Users, out out of the box. These fields are not necessary if only an email address is known
for the recipient.
email_address_id is the ID of the email address the recipient used in the email. To get
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-31
|
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 action is supported. Metadata about each attachment is required to link the records.
filename_guid is the temporary file ID for an uploaded file to attach as a Notes record.
upload_id is the ID of an existing file that the Notes record should reference as the
attachment. This allows files to be shared by multiple Notes records, to preserve space.
When using upload_id, file_source should be provided to indicate from where the
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-32
|
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",
"outbound_email_id": "b80adf1a-7d78-11e7-855a-3c15c2d582c6",
"name": "Discuss Proposal",
"description_html": "<p>When is a good time for us to chat?</p>",
"parent_type": "Leads",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-33
|
"parent_type": "Leads",
"parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6",
"to": {
"create": [{
"parent_type": "Leads",
"parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6"
}]
},
"cc": {
"create": [{
"parent_type": "Users",
"parent_id": "79c2e800-7d79-11e7-84af-3c15c2d582c6"
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-34
|
"email_address_id": "79cc341e-7d79-11e7-8748-3c15c2d582c6"
}]
},
"attachments": {
"create": [{
"upload_id": "a028341c-ba92-9343-55e7-56cf5beda121",
"name": "Contract.pdf",
"filename": "Contract.pdf",
"file_source": "DocumentRevisions"
}, {
"upload_id": "18a72782-4514-11e6-a5f7-3c15c2d582c6",
"name": "survey.doc",
"filename": "survey.doc",
"file_source": "EmailTemplates"
}]
}
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-35
|
"file_source": "EmailTemplates"
}]
}
}
Response
{
"id": "a7795664-7def-11e7-8add-3c15c2d582c6",
"date_entered": "2016-02-25T08:53:07-08:00",
"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",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-36
|
"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",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html
|
d49cc1169547-37
|
"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"
"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/Emails_POST/index.html
|
d49cc1169547-38
|
"primary": true,
"selected": false
}],
"my_favorite": false,
"_acl": {
"fields": {}
},
"_module": "Emails"
}
Change Log
Version
Change
v10
Added /Emails 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/Emails_POST/index.html
|
e8aba870f2d3-0
|
/<module>/favorites GET
Overview
Opportunity Favorites Help
Summary
This endpoint returns all the favorite Quotes/Revenue Line Items in alphabetical order to be displayed in the
"Product Catalog Quick Picks" dashlet.
Request Arguments
Name
Type
Description
Required
pageNum
integer
An integer attribute in the payload data object which gets the page number for which the items need to be
displayed based on the current page or the page clicked.
False
Request
{
pageNum: 0
}
Response Arguments
Name
Type
Description
<config field>
<config field type>
The list of config fields will be returned.
Response
{
"totalPages":5,
"pageNum":0,
"max_num":8,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html
|
e8aba870f2d3-1
|
"pageNum":0,
"max_num":8,
"records":[
{
"id":"c181bd32-c7f2-11e8-b4eb-7831c1c14620",
"name":"Allyson Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html
|
e8aba870f2d3-2
|
"category_id":"c18112d8-c7f2-11e8-b753-7831c1c14620",
"mft_part_num":"Ink Conglomerate Inc 921535XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"534.000000",
"discount_price":"842.000000",
"list_price":"905.000000",
"cost_usdollar":"534.000000",
"discount_usdollar":"842.000000",
"list_usdollar":"905.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html
|
e8aba870f2d3-3
|
"website":null,
"weight":"20.00",
"qty_in_stock":26,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"Fixed",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"base_rate":"1.000000"
},
{
"id":"c18e0448-c7f2-11e8-86b0-7831c1c14620",
"name":"Arla Gadget",
"date_entered":"2018-10-04 16:28:37",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html
|
e8aba870f2d3-4
|
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c18b8b64-c7f2-11e8-8c1a-7831c1c14620",
"mft_part_num":"24\/7 Couriers 795391XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html
|
e8aba870f2d3-5
|
"date_cost_price":null,
"cost_price":"398.000000",
"discount_price":"402.020202",
"list_price":"941.000000",
"cost_usdollar":"398.000000",
"discount_usdollar":"402.020202",
"list_usdollar":"941.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"22.00",
"qty_in_stock":145,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"ProfitMargin",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html
|
e8aba870f2d3-6
|
"pricing_formula":"ProfitMargin",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"base_rate":"1.000000"
},
{
"id":"c1b60434-c7f2-11e8-8964-7831c1c14620",
"name":"Billie Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html
|
e8aba870f2d3-7
|
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c1b3bf58-c7f2-11e8-92e7-7831c1c14620",
"mft_part_num":"Kringle Bell IncK.A. Tower \u0026 Co 694143XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"403.000000",
"discount_price":"927.000000",
"list_price":"927.000000",
"cost_usdollar":"403.000000",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html
|
e8aba870f2d3-8
|
"cost_usdollar":"403.000000",
"discount_usdollar":"927.000000",
"list_usdollar":"927.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"16.00",
"qty_in_stock":148,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"IsList",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"base_rate":"1.000000"
},
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html
|
e8aba870f2d3-9
|
"base_rate":"1.000000"
},
{
"id":"c186a612-c7f2-11e8-9fee-7831c1c14620",
"name":"Bradford Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html
|
e8aba870f2d3-10
|
"category_id":"c185dbb0-c7f2-11e8-a6b7-7831c1c14620",
"mft_part_num":"Mississippi Bank Group 133834XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"528.000000",
"discount_price":"533.333333",
"list_price":"745.000000",
"cost_usdollar":"528.000000",
"discount_usdollar":"533.333333",
"list_usdollar":"745.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"33.00",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html
|
e8aba870f2d3-11
|
"website":null,
"weight":"33.00",
"qty_in_stock":70,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"ProfitMargin",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"base_rate":"1.000000"
},
{
"id":"c1b4680e-c7f2-11e8-9380-7831c1c14620",
"name":"Brain Gadget",
"date_entered":"2018-10-04 16:28:37",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html
|
e8aba870f2d3-12
|
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c1b3bf58-c7f2-11e8-92e7-7831c1c14620",
"mft_part_num":"Smallville Resources Inc 362299XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html
|
e8aba870f2d3-13
|
"date_cost_price":null,
"cost_price":"370.000000",
"discount_price":"854.370000",
"list_price":"863.000000",
"cost_usdollar":"370.000000",
"discount_usdollar":"854.370000",
"list_usdollar":"863.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"10.00",
"qty_in_stock":106,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"PercentageDiscount",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html
|
e8aba870f2d3-14
|
"pricing_formula":"PercentageDiscount",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"base_rate":"1.000000"
},
{
"id":"c1baf0e8-c7f2-11e8-ab05-7831c1c14620",
"name":"Carley Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html
|
e8aba870f2d3-15
|
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c1b8e4ec-c7f2-11e8-b435-7831c1c14620",
"mft_part_num":"Hollywood Diner Ltd 10023XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"554.000000",
"discount_price":"559.595960",
"list_price":"927.000000",
"cost_usdollar":"554.000000",
"discount_usdollar":"559.595959",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html
|
e8aba870f2d3-16
|
"discount_usdollar":"559.595959",
"list_usdollar":"927.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"30.00",
"qty_in_stock":58,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"ProfitMargin",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"base_rate":"1.000000"
},
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html
|
e8aba870f2d3-17
|
"base_rate":"1.000000"
},
{
"id":"c1b77544-c7f2-11e8-8347-7831c1c14620",
"name":"Carma Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html
|
e8aba870f2d3-18
|
"category_id":"c1b3bf58-c7f2-11e8-92e7-7831c1c14620",
"mft_part_num":"Sea Region Inc 773472XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"332.000000",
"discount_price":"745.000000",
"list_price":"822.000000",
"cost_usdollar":"332.000000",
"discount_usdollar":"745.000000",
"list_usdollar":"822.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"35.00",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html
|
e8aba870f2d3-19
|
"website":null,
"weight":"35.00",
"qty_in_stock":1,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"Fixed",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"base_rate":"1.000000"
},
{
"id":"c1b98c9e-c7f2-11e8-9740-7831c1c14620",
"name":"Catrina Gadget",
"date_entered":"2018-10-04 16:28:37",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html
|
e8aba870f2d3-20
|
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c1b8e4ec-c7f2-11e8-b435-7831c1c14620",
"mft_part_num":"Jungle Systems Inc 273034XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html
|
e8aba870f2d3-21
|
"date_cost_price":null,
"cost_price":"577.000000",
"discount_price":"582.770000",
"list_price":"946.000000",
"cost_usdollar":"577.000000",
"discount_usdollar":"582.770000",
"list_usdollar":"946.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"13.00",
"qty_in_stock":105,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"PercentageMarkup",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html
|
e8aba870f2d3-22
|
"pricing_formula":"PercentageMarkup",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"base_rate":"1.000000"
}
]
}
Change Log
Version
Change
v10
Added /Opportunities/favorites 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/modulefavorites_GET/index.html
|
f581cea19cec-0
|
/Dashboards/<module> POST
Create a new dashboard.
Notice
This endpoint is not supported in v11. If you continue to use v10 of the API, your
REST calls should behave as below. But, it is advisable to upgrade to v11.Migrating to v11:
For more information on behavior in v11, refer to POST /<module>.
Recommended Replacement: POST /Dashboards
The module name is no longer part of the path. To specify a module name, include it in the Request Body.
For example, to create an Accounts module dashboard, usev11: POST /Dashboards with the following in the Request Body:
{"dashboard_module":"Accounts"}
Request Arguments
Name
Type
Description
Required
<record field>
<record field type>
The name value list of fields to populate.
True
Request
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboardsmodule_POST/index.html
|
f581cea19cec-1
|
The name value list of fields to populate.
True
Request
{
"name": "New Dashboard for Accounts Module",
"dashboard_module": "Accounts",
"view_name": "records",
"metadata": {
"components": [{
"rows": [[{
"view": {
"type": "dashablelist",
"label": "TPL_DASHLET_MY_MODULE",
"display_columns": ["name","billing_address_city"]
},
"context": {"module":"Accounts"},
"width": 12
}]],
"width": 12
}]
}
}
Response Arguments
Name
Type
Description
<record field>
<record field type>
Returns the fields for the newly created dashboard.
Response
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboardsmodule_POST/index.html
|
f581cea19cec-2
|
<record field type>
Returns the fields for the newly created dashboard.
Response
{
"id": "8f9cd3d1-ce5d-e8d4-12d8-56cf674d2600",
"name": "New Dashboard for Accounts Module",
"date_entered": "2016-02-25T12:44:27-08:00",
"date_modified": "2016-02-25T12:44:27-08:00",
"modified_user_id": "1",
"modified_by_name": "Administrator",
"created_by": "1",
"created_by_name": "Administrator",
"description": "",
"deleted": false,
"dashboard_module": "Accounts",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboardsmodule_POST/index.html
|
f581cea19cec-3
|
"deleted": false,
"dashboard_module": "Accounts",
"view_name": "records",
"metadata": {
"components": [
{
"rows": [
[
{
"view": {
"type": "dashablelist",
"label": "TPL_DASHLET_MY_MODULE",
"display_columns": [
"name",
"billing_address_city"
]
},
"context": {
"module": "Accounts"
},
"width": 12
}
]
],
"width": 12
}
]
},
"following": "",
"my_favorite": false,
"tag": [],
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboardsmodule_POST/index.html
|
f581cea19cec-4
|
"my_favorite": false,
"tag": [],
"assigned_user_id": "1",
"assigned_user_name": "Administrator",
"_acl": {
"fields": {}
},
"view": "records",
"_module": "Dashboards"
}
Change Log
Version
Change
v11
No longer supported. Please use POST /Dashboards instead.
v10
Added /Dashboards/<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/Dashboardsmodule_POST/index.html
|
af73fbff2508-0
|
/ProductTemplates/tree POST
ProductTemplate API
Summary:
This endpoint is designed to return a paged recordset of one level of product templates and product categories in
a N-level deep tree representing the relationship between categories and templates. The results are loosely
filtered (wildcard before and after).
Query Parameters:
Param
Description
Optional
filter
The filter used to search Product Template and Product Category names. %filter%
true
root
The ID of the root node you wish to retrieve. Defaults to null (the root level)
true
offset
Specifies the numeric value of the offset you wish to retrieve
true
max_num
Specifies the numeric value of the max number of records you wish to receive. Default is 20.
true
Response Parameters:
Param
Description
id
The id of the item (Product Category/Template)
Data
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ProductTemplatestree_POST/index.html
|
af73fbff2508-1
|
Description
id
The id of the item (Product Category/Template)
Data
The name of the item
state
Specifies the open or closed state of the element. (used for categories)
index
Specifies the index of this element in the current level.
Response:
{
"records":[
{
"id":"023d316a-d9d0-11e7-9f54-02425392a518",
"type":"category",
"data":"Christen Widgets",
"state":"closed",
"index":0
},
{
"id":"01828a4a-d9d0-11e7-8989-02425392a518",
"type":"category",
"data":"Desktops",
"state":"closed",
"index":1
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ProductTemplatestree_POST/index.html
|
af73fbff2508-2
|
"state":"closed",
"index":1
}
],
"next_offset":2
}
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ProductTemplatestree_POST/index.html
|
439d4789c370-0
|
/<module>/:record/pii GET
Overview
Returns personally identifiable information (pii) fields with current data and source of data capture for a specific record.
Version Requirements
Minimum REST API Version required - 11.1
Request Arguments
Name
Type
Description
Required
module
String
The name of the module.
True
record
String
The record id.
True
Response Arguments
Name
Type
Description
records
String
Returns the set of PII field records for the given module record.
Response
{
"fields": [
{
"field_name": "phone_mobile",
"value": "(645) 604-0128",
"event_type": "update",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordpii_GET/index.html
|
439d4789c370-1
|
"event_type": "update",
"date_modified": "2018-02-21T19:56:42+00:00",
"source": {
"subject": {
"_type": "user",
"id": "999b3b50-16dc-11e8-9c03-a45e60e64123",
"_module": "Users",
"client": {
"_type": "rest-api"
},
"first_name": "Tim",
"last_name": "Zhang",
"name": "Tim Zhang"
},
"attributes": {
"platform": "base"
}
}
},
{
"field_name": "phone_work",
"value": "(212) 692-3480",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordpii_GET/index.html
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.