id
stringlengths
14
16
text
stringlengths
33
5.27k
source
stringlengths
105
270
4a3b2cfeb112-0
/Emails/filter POST 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. False filter_id String Identifier for a preexisting filter. If filter is also set, the two filters are joined with an AND. False max_num Integer A maximum number of records to return. Default is 20. False offset Integer The number of records to skip over before records are returned. Default is 0. False fields String Comma delimited list of fields to return. The field date_modified will always be returned. Example: name,account_type,description False view String Instead of defining the fields argument, the view argument can be used instead. The field list is
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html
4a3b2cfeb112-1
constructed at the server side based on the view definition which is requested. This argument can be used in combination with the fields argument. Common views are "record" and "list". Example: record False order_by String How to sort the returned records, in a comma delimited list with the direction appended to the column name after a colon. Example: name:DESC,account_type:DESC,date_modified:ASC False Filter Expressions There are four types of filters: Basic 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
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html
4a3b2cfeb112-2
Matches anything that contains the value $in Finds anything where field matches one of the values as specified as an array. $not_in Finds anything where field does not matches any of the values as specified as an array. $is_null Checks if the field is null. This operation does not need a value specified. $not_null Checks if the field is not null. This operation does not need a value specified. $lt Matches when the field is less than the value. $lte Matches when the field is less than or equal to the value. $gt Matches when the field is greater than the value. $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
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html
4a3b2cfeb112-3
filter the records in the current module to only your favorites. The only currently accepted module expressions are "$favorite" and "$owner". Example { "filter":[ { "$favorite":"_this" } ] } Response Arguments Name Type Description next_offset Integer Displays the next offset for retrieval of additional results. -1 will be returned when there are no more records. records Array An array of results containing matched records. Response { "next_offset":-1, "records":[ { "id":"fa300a0e-0ad1-b322-9601-512d0983c19a", "name":"Dale Spivey", "date_entered":"2013-02-26T19:12:00+00:00", "date_modified":"2013-02-28T05:03:00+00:00", "modified_user_id":"1", "modified_by_name":"Administrator", "created_by":"1", "created_by_name":"Administrator", "description":"", "img":"", "deleted":false, "assigned_user_id":"seed_sally_id", "assigned_user_name":"Sally Bronsen", "team_name":[ { "id":"East", "name":"East", "name_2":"", "primary":false }, { "id":1, "name":"Global", "name_2":"", "primary":false }, { "id":"West",
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html
4a3b2cfeb112-4
"primary":false }, { "id":"West", "name":"West", "name_2":"", "primary":true } ], "salutation":"", "first_name":"Dale", "last_name":"Spivey", "full_name":"Dale Spivey", "title":"VP Operations", "linkedin":"", "facebook":"", "twitter":"", "googleplus":"", "department":"", "do_not_call":false, "phone_home":"(523) 825-4311", "email":[ { "email_address":"[email protected]", "opt_out":"0", "invalid_email":"0", "primary_address":"1" }, { "email_address":"[email protected]", "opt_out":"0", "invalid_email":"0", "primary_address":"0" } ], "phone_mobile":"(373) 861-0757", "phone_work":"(212) 542-9596", "phone_other":"", "phone_fax":"", "email1":"[email protected]", "email2":"[email protected]", "invalid_email":false, "email_opt_out":false, "primary_address_street":"345 Sugar Blvd.", "primary_address_street_2":"", "primary_address_street_3":"", "primary_address_city":"Denver", "primary_address_state":"CA", "primary_address_postalcode":"87261", "primary_address_country":"USA",
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html
4a3b2cfeb112-5
"primary_address_country":"USA", "alt_address_street":"", "alt_address_street_2":"", "alt_address_street_3":"", "alt_address_city":"", "alt_address_state":"", "alt_address_postalcode":"", "alt_address_country":"", "assistant":"", "assistant_phone":"", "picture":"", "email_and_name1":"", "lead_source":"Campaign", "account_name":"Smallville Resources Inc", "account_id":"d5db6292-5c24-eb61-e202-512d09f0134e", "opportunity_role_fields":"", "opportunity_role_id":"", "opportunity_role":"", "reports_to_id":"", "report_to_name":"", "portal_name":"DaleSpivey97", "portal_active":true, "portal_password":"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\/", "portal_password1":"", "portal_app":"", "preferred_language":"en_us", "campaign_id":"", "campaign_name":"", "c_accept_status_fields":"", "m_accept_status_fields":"", "accept_status_id":"", "accept_status_name":"", "sync_contact":"", "my_favorite":false, "_acl":{ "fields":{ } } }, { "id":"95e17367-9b3d-0e26-22dc-512d0961fedf", "name":"Florence Haddock",
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html
4a3b2cfeb112-6
"name":"Florence Haddock", "date_entered":"2013-02-26T19:12:00+00:00", "date_modified":"2013-02-26T19:12:00+00:00", "modified_user_id":"1", "modified_by_name":"Administrator", "created_by":"1", "created_by_name":"Administrator", "description":"", "img":"", "deleted":false, "assigned_user_id":"seed_sally_id", "assigned_user_name":"Sally Bronsen", "team_name":[ { "id":"East", "name":"East", "name_2":"", "primary":false }, { "id":1, "name":"Global", "name_2":"", "primary":false }, { "id":"West", "name":"West", "name_2":"", "primary":true } ], "salutation":"", "first_name":"Florence", "last_name":"Haddock", "full_name":"Florence Haddock", "title":"Director Sales", "linkedin":"", "facebook":"", "twitter":"", "googleplus":"", "department":"", "do_not_call":false, "phone_home":"(729) 845-3137", "email":[ { "email_address":"[email protected]", "opt_out":"1", "invalid_email":"0", "primary_address":"0" }, {
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html
4a3b2cfeb112-7
"primary_address":"0" }, { "email_address":"[email protected]", "opt_out":"0", "invalid_email":"0", "primary_address":"1" } ], "phone_mobile":"(246) 233-1382", "phone_work":"(565) 696-6981", "phone_other":"", "phone_fax":"", "email1":"[email protected]", "email2":"[email protected]", "invalid_email":false, "email_opt_out":false, "primary_address_street":"111 Silicon Valley Road", "primary_address_street_2":"", "primary_address_street_3":"", "primary_address_city":"Denver", "primary_address_state":"CA", "primary_address_postalcode":"79900", "primary_address_country":"USA", "alt_address_street":"", "alt_address_street_2":"", "alt_address_street_3":"", "alt_address_city":"", "alt_address_state":"", "alt_address_postalcode":"", "alt_address_country":"", "assistant":"", "assistant_phone":"", "picture":"", "email_and_name1":"", "lead_source":"Support Portal User Registration", "account_name":"Smallville Resources Inc", "account_id":"d5db6292-5c24-eb61-e202-512d09f0134e", "opportunity_role_fields":"", "opportunity_role_id":"", "opportunity_role":"", "reports_to_id":"", "report_to_name":"",
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html
4a3b2cfeb112-8
"reports_to_id":"", "report_to_name":"", "portal_name":"FlorenceHaddock169", "portal_active":true, "portal_password":"$1$nWFhTbK6$JF9BCGSqL\/NCrbhueX5ia0", "portal_password1":"", "portal_app":"", "preferred_language":"en_us", "campaign_id":"", "campaign_name":"", "c_accept_status_fields":"", "m_accept_status_fields":"", "accept_status_id":"", "accept_status_name":"", "sync_contact":"", "my_favorite":false, "_acl":{ "fields":{ } } } ] } Change Log Version Change v10 Added /<module>/filter POST endpoint. Last modified: 2023-02-03 21:04:03
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html
df8b54321d25-0
/VCardDownload GET Overview Downloads a vCard. Request Arguments Name Type Description Required id String The id of the vcard. True module String The name of the module to get the vcard from. True Request http://{site_url}/rest/v10/VCardDownload?id=2c9e5c09-6824-0d14-f5cb-5130321ac3cf&module=Contacts Note: GET endpoint parameters are passed in the form of a query string. Response Arguments Name Type Description <vcard information> String; Record in vcard format. Response BEGIN:VCARD N;CHARSET=utf-8:Leone;Rosemarie;; FN;CHARSET=utf-8: Rosemarie Leone BDAY: TEL;WORK;FAX: TEL;HOME;CHARSET=utf-8:(692) 586-8287 TEL;CELL;CHARSET=utf-8:(117) 577-0969 TEL;WORK;CHARSET=utf-8:(844) 325-7679 EMAIL;INTERNET;CHARSET=utf-8:[email protected] ADR;WORK;CHARSET=utf-8:;;777 West Filmore Ln;San Mateo;CA;74984;USA ORG;CHARSET=utf-8:Q.R.&E. Corp; TITLE;CHARSET=utf-8:Director Sales END:VCARD Change Log Version Change v10 Added /VCardDownload 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/VCardDownload_GET/index.html
38b2cbc86385-0
/<module>/:record/link/:link_name/count GET Overview Lists related filtered records. Summary This endpoint will return a set of related records filtered by an expression. The filter can be applied to multiple fields and have multiple and/or conditions in it. Care will need to be taken to make sure this filter has appropriate indexes on the server side otherwise the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as: "link_name.remote_field", so if you wished to search the Accounts module by a related member account you would use "members.sic_code". Request Arguments Name Type Description Required filter String The filter expression. Filter expressions are explained below. False max_num Integer A maximum number of records to return. Default is 20. False offset Integer The number of records to skip over before records are returned. Default is 0. False fields String Comma delimited list of fields to return. The field date_modified will always be returned. This argument can be combined with the view argument. Example: name,account_type,description False view String Instead of defining the fields argument, the view argument can be used instead. The field list is constructed at the server side based on the view definition which is requested. This argument can be used in combination with the fields argument. Common views are "record" and "list". Example: record False order_by String
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html
38b2cbc86385-1
False order_by String How to sort the returned records, in a comma delimited list with the direction appended to the column name after a colon. Example: name:DESC,account_type:DESC,date_modified:ASC False Filter Expressions There are four types of filters: Basic This will filter the results by checking the field "name" for value "Nelson Inc". This will only find exact matches. Example { "filter":[ { "name":"Nelson Inc" } ] } Full This expression allows you to specify what operation you want to use for filtering on the field. In the example you 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.
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html
38b2cbc86385-2
$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/modulerecordlinklink_namecount_GET/index.html
38b2cbc86385-3
] } 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. Repsonse { "next_offset":-1, "records":[ { "id":"fa300a0e-0ad1-b322-9601-512d0983c19a", "name":"Dale Spivey", "date_entered":"2013-02-26T19:12:00+00:00", "date_modified":"2013-02-28T05:03:00+00:00", "modified_user_id":"1", "modified_by_name":"Administrator", "created_by":"1", "created_by_name":"Administrator", "description":"", "img":"", "deleted":false, "assigned_user_id":"seed_sally_id", "assigned_user_name":"Sally Bronsen", "team_name":[ { "id":"East", "name":"East", "name_2":"", "primary":false }, { "id":1, "name":"Global", "name_2":"", "primary":false }, { "id":"West", "name":"West", "name_2":"", "primary":true } ], "salutation":"", "first_name":"Dale", "last_name":"Spivey",
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html
38b2cbc86385-4
"first_name":"Dale", "last_name":"Spivey", "full_name":"Dale Spivey", "title":"VP Operations", "linkedin":"", "facebook":"", "twitter":"", "googleplus":"", "department":"", "do_not_call":false, "phone_home":"(523) 825-4311", "email":[ { "email_address":"[email protected]", "opt_out":"0", "invalid_email":"0", "primary_address":"1" }, { "email_address":"[email protected]", "opt_out":"0", "invalid_email":"0", "primary_address":"0" } ], "phone_mobile":"(373) 861-0757", "phone_work":"(212) 542-9596", "phone_other":"", "phone_fax":"", "email1":"[email protected]", "email2":"[email protected]", "invalid_email":false, "email_opt_out":false, "primary_address_street":"345 Sugar Blvd.", "primary_address_street_2":"", "primary_address_street_3":"", "primary_address_city":"Denver", "primary_address_state":"CA", "primary_address_postalcode":"87261", "primary_address_country":"USA", "alt_address_street":"", "alt_address_street_2":"", "alt_address_street_3":"", "alt_address_city":"", "alt_address_state":"", "alt_address_postalcode":"",
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html
38b2cbc86385-5
"alt_address_state":"", "alt_address_postalcode":"", "alt_address_country":"", "assistant":"", "assistant_phone":"", "picture":"", "email_and_name1":"", "lead_source":"Campaign", "account_name":"Smallville Resources Inc", "account_id":"d5db6292-5c24-eb61-e202-512d09f0134e", "opportunity_role_fields":"", "opportunity_role_id":"", "opportunity_role":"", "reports_to_id":"", "report_to_name":"", "portal_name":"DaleSpivey97", "portal_active":true, "portal_password":"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\/", "portal_password1":"", "portal_app":"", "preferred_language":"en_us", "campaign_id":"", "campaign_name":"", "c_accept_status_fields":"", "m_accept_status_fields":"", "accept_status_id":"", "accept_status_name":"", "sync_contact":"", "my_favorite":false, "_acl":{ "fields":{ } } }, { "id":"95e17367-9b3d-0e26-22dc-512d0961fedf", "name":"Florence Haddock", "date_entered":"2013-02-26T19:12:00+00:00", "date_modified":"2013-02-26T19:12:00+00:00",
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html
38b2cbc86385-6
"modified_user_id":"1", "modified_by_name":"Administrator", "created_by":"1", "created_by_name":"Administrator", "description":"", "img":"", "deleted":false, "assigned_user_id":"seed_sally_id", "assigned_user_name":"Sally Bronsen", "team_name":[ { "id":"East", "name":"East", "name_2":"", "primary":false }, { "id":1, "name":"Global", "name_2":"", "primary":false }, { "id":"West", "name":"West", "name_2":"", "primary":true } ], "salutation":"", "first_name":"Florence", "last_name":"Haddock", "full_name":"Florence Haddock", "title":"Director Sales", "linkedin":"", "facebook":"", "twitter":"", "googleplus":"", "department":"", "do_not_call":false, "phone_home":"(729) 845-3137", "email":[ { "email_address":"[email protected]", "opt_out":"1", "invalid_email":"0", "primary_address":"0" }, { "email_address":"[email protected]", "opt_out":"0", "invalid_email":"0", "primary_address":"1" } ], "phone_mobile":"(246) 233-1382",
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html
38b2cbc86385-7
], "phone_mobile":"(246) 233-1382", "phone_work":"(565) 696-6981", "phone_other":"", "phone_fax":"", "email1":"[email protected]", "email2":"[email protected]", "invalid_email":false, "email_opt_out":false, "primary_address_street":"111 Silicon Valley Road", "primary_address_street_2":"", "primary_address_street_3":"", "primary_address_city":"Denver", "primary_address_state":"CA", "primary_address_postalcode":"79900", "primary_address_country":"USA", "alt_address_street":"", "alt_address_street_2":"", "alt_address_street_3":"", "alt_address_city":"", "alt_address_state":"", "alt_address_postalcode":"", "alt_address_country":"", "assistant":"", "assistant_phone":"", "picture":"", "email_and_name1":"", "lead_source":"Support Portal User Registration", "account_name":"Smallville Resources Inc", "account_id":"d5db6292-5c24-eb61-e202-512d09f0134e", "opportunity_role_fields":"", "opportunity_role_id":"", "opportunity_role":"", "reports_to_id":"", "report_to_name":"", "portal_name":"FlorenceHaddock169", "portal_active":true, "portal_password":"$1$nWFhTbK6$JF9BCGSqL\/NCrbhueX5ia0",
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html
38b2cbc86385-8
"portal_password1":"", "portal_app":"", "preferred_language":"en_us", "campaign_id":"", "campaign_name":"", "c_accept_status_fields":"", "m_accept_status_fields":"", "accept_status_id":"", "accept_status_name":"", "sync_contact":"", "my_favorite":false, "_acl":{ "fields":{ } } } ] } Change Log Version Change v10 Added /<module>/:record/link/:link_name/filter GET endpoint. Last modified: 2023-02-03 21:04:03
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html
4700a038a97a-0
/pmse_Inbox/changeCaseUser/:cas_id GET Overview Deprecated endpoint. Summary This endpoint is deprecated and will be removed in a future release. Last modified: 2023-02-03 21:04:03
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxchangeCaseUsercas_id_GET/index.html
827e213a1a3c-0
/pmse_Inbox/save_notes POST Overview Creates a new note for a process Summary This endpoint creates a new note for a process Request Arguments Name Type Description Required data array Collection of data for a note containing the following: true data.cas_id string The id of the process trigger sequence true data.cas_index string The step in the process true data.not_content string The content of the note true data.not_type string The type of note, defaults to 'GENERAL' false Response Arguments Name Type Description success boolean Result of the update id string Id of new note date_entered date Date of creation Response { "success":true, "id":"06c075d0-28e7-11e6-8bb1-6c4008960436", "date_entered":"2016-06-02T10:25:39-07:00" } Last modified: 2023-02-03 21:04:03
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxsave_notes_POST/index.html
f2d7decfb3ca-0
/integrate/<module>/:sync_key_field_name/:sync_key_field_value PUT Overview Upserts based on sync_key_field_name. If a record can be found with sync_key_field_name, then update. If the record does not exist, then create it. Note that the PATCH method is recommended over the PUT method. Note: This endpoint cannot be used to set the sync_key_field_name for an existing Sugar record. To do so, it is recommended to use the set sync key endpoint to update the matching Sugar record ID. Once the sync_key_field_name is set for the record, then it is possible to leverage this endpoint. Request Arguments Name Type Description Required module String The module the record belongs to True sync_key_field_name String The name of the field that contains sync_key_field_value (the default field is named sync_key but can be renamed via code customization) True sync_key_field_value String A unique ID for the record identifying it in an external system True Request /integrate/<module>/:sync_key_field_name/:sync_key_field_value Response Arguments Name Type Description record String The ID of the record that was upserted. Response Status 201: For a created record Status 200: For an updated record { record: "a0328573-a252-a27c-3530-4e4297d4c9e1"} Change Log Version Change v11_10 Added /integrate/<module>/:sync_key_field_name/:sync_key_field_value PUT endpoint. Last modified: 2023-02-03 21:04:03
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Integratemodulesync_key_field_namesync_key_field_value_PUT/index.html
f277a6503a69-0
/pmse_Inbox/settings PUT Overview Update settings for the SugarBPMTM engine Summary This endpoint updates settings for the SugarBPMTM engine Request Arguments Name Type Description Required data array Key/value map of config keys and their associated values for the SugarBPMTM engine to update false Response Arguments Name Type Description success boolean Result of update data object Key/Value map of config keys and their new values Response { "success":true, "data": { "logger_level":"critical", "error_number_of_cycles":"10", "error_timeout":"40" } } 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_Inboxsettings_PUT/index.html
ebca27356043-0
/pmse_Project/validateCrmData/:data/:filter GET Overview Validates information about Fields, Modules, Users, Roles, etc. Summary This endpoint will validate the existence of various data related to the Process Definition. Request Arguments Name Type Description Required data String The type of data to be retrieved True filter String Filtering criteria to be applied to data retrieved False key String Key of the entry to search for within the given data and filter True Request Note: "key" should be provided in the form of a URL query string. Example Request: /rest/v11_10/pmse_Project/validateCrmData/field/Accounts?key=data_entered Response Arguments Name Type Description result Boolean The result of the validation. True if the key exists in the specified data set; false otherwise Response { result: true } Change Log Version Change v11_10 Added /pmse_Project/validateCrmData/:data/:filter GET endpoint. Last modified: 2023-02-03 21:04:03
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectvalidateCrmDatadatafilter_GET/index.html
e4dc023c9224-0
/pmse_Business_Rules/file/businessrules_import POST Overview Imports a Process Business Rules definition from a .pbr file Summary This endpoint will import a Process Business Rules definition from the uploaded .pbr file containing JSON encoded data. Request Arguments Name Type Description Required N/A Request Note: A JSON encoded .pbr file attachment should be included with the request as part of the form-data. Response Arguments Name Type Description businessrules_import Object Result of the import operation Response { "businessrules_import": { "success":true, "id":"e4396c91-81cd-c097-8149-5733bab68316" } } 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_Business_Rulesfilebusinessrules_import_POST/index.html
328f6f016a92-0
/<module>/filter/count GET Overview Lists filtered records. Summary This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id. If both a filter definition and a filter id are passed, the two filters will be joined with an AND. Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as: "link_name.remote_field", so if you wished to search the Accounts module by a related member account you would use "members.sic_code". Request Arguments Name Type Description Required filter String The filter expression. Filter expressions are explained below. False filter_id String Identifier for a preexisting filter. If filter is also set, the two filters are joined with an AND. False max_num Integer A maximum number of records to return. Default is 20. False offset Integer The number of records to skip over before records are returned. Default is 0. False fields String Comma delimited list of fields to return. The field date_modified will always be returned. Example: name,account_type,description False view String Instead of defining the fields argument, the view argument can be used instead. The field list is
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefiltercount_GET/index.html
328f6f016a92-1
constructed at the server side based on the view definition which is requested. This argument can be used in combination with the fields argument. Common views are "record" and "list". Example: record False order_by String How to sort the returned records, in a comma delimited list with the direction appended to the column name after a colon. Example: name:DESC,account_type:DESC,date_modified:ASC False Filter Expressions There are four types of filters: Basic 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
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefiltercount_GET/index.html
328f6f016a92-2
Matches anything that contains the value $in Finds anything where field matches one of the values as specified as an array. $not_in Finds anything where field does not matches any of the values as specified as an array. $is_null Checks if the field is null. This operation does not need a value specified. $not_null Checks if the field is not null. This operation does not need a value specified. $lt Matches when the field is less than the value. $lte Matches when the field is less than or equal to the value. $gt Matches when the field is greater than the value. $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
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefiltercount_GET/index.html
328f6f016a92-3
filter the records in the current module to only your favorites. The only currently accepted module expressions are "$favorite" and "$owner". Example { "filter":[ { "$favorite":"_this" } ] } Response Arguments Name Type Description next_offset Integer Displays the next offset for retrieval of additional results. -1 will be returned when there are no more records. records Array An array of results containing matched records. Response { "next_offset":-1, "records":[ { "id":"fa300a0e-0ad1-b322-9601-512d0983c19a", "name":"Dale Spivey", "date_entered":"2013-02-26T19:12:00+00:00", "date_modified":"2013-02-28T05:03:00+00:00", "modified_user_id":"1", "modified_by_name":"Administrator", "created_by":"1", "created_by_name":"Administrator", "description":"", "img":"", "deleted":false, "assigned_user_id":"seed_sally_id", "assigned_user_name":"Sally Bronsen", "team_name":[ { "id":"East", "name":"East", "name_2":"", "primary":false }, { "id":1, "name":"Global", "name_2":"", "primary":false }, { "id":"West",
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefiltercount_GET/index.html
328f6f016a92-4
"primary":false }, { "id":"West", "name":"West", "name_2":"", "primary":true } ], "salutation":"", "first_name":"Dale", "last_name":"Spivey", "full_name":"Dale Spivey", "title":"VP Operations", "linkedin":"", "facebook":"", "twitter":"", "googleplus":"", "department":"", "do_not_call":false, "phone_home":"(523) 825-4311", "email":[ { "email_address":"[email protected]", "opt_out":"0", "invalid_email":"0", "primary_address":"1" }, { "email_address":"[email protected]", "opt_out":"0", "invalid_email":"0", "primary_address":"0" } ], "phone_mobile":"(373) 861-0757", "phone_work":"(212) 542-9596", "phone_other":"", "phone_fax":"", "email1":"[email protected]", "email2":"[email protected]", "invalid_email":false, "email_opt_out":false, "primary_address_street":"345 Sugar Blvd.", "primary_address_street_2":"", "primary_address_street_3":"", "primary_address_city":"Denver", "primary_address_state":"CA", "primary_address_postalcode":"87261", "primary_address_country":"USA",
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefiltercount_GET/index.html
328f6f016a92-5
"primary_address_country":"USA", "alt_address_street":"", "alt_address_street_2":"", "alt_address_street_3":"", "alt_address_city":"", "alt_address_state":"", "alt_address_postalcode":"", "alt_address_country":"", "assistant":"", "assistant_phone":"", "picture":"", "email_and_name1":"", "lead_source":"Campaign", "account_name":"Smallville Resources Inc", "account_id":"d5db6292-5c24-eb61-e202-512d09f0134e", "opportunity_role_fields":"", "opportunity_role_id":"", "opportunity_role":"", "reports_to_id":"", "report_to_name":"", "portal_name":"DaleSpivey97", "portal_active":true, "portal_password":"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\/", "portal_password1":"", "portal_app":"", "preferred_language":"en_us", "campaign_id":"", "campaign_name":"", "c_accept_status_fields":"", "m_accept_status_fields":"", "accept_status_id":"", "accept_status_name":"", "sync_contact":"", "my_favorite":false, "_acl":{ "fields":{ } } }, { "id":"95e17367-9b3d-0e26-22dc-512d0961fedf", "name":"Florence Haddock",
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefiltercount_GET/index.html
328f6f016a92-6
"name":"Florence Haddock", "date_entered":"2013-02-26T19:12:00+00:00", "date_modified":"2013-02-26T19:12:00+00:00", "modified_user_id":"1", "modified_by_name":"Administrator", "created_by":"1", "created_by_name":"Administrator", "description":"", "img":"", "deleted":false, "assigned_user_id":"seed_sally_id", "assigned_user_name":"Sally Bronsen", "team_name":[ { "id":"East", "name":"East", "name_2":"", "primary":false }, { "id":1, "name":"Global", "name_2":"", "primary":false }, { "id":"West", "name":"West", "name_2":"", "primary":true } ], "salutation":"", "first_name":"Florence", "last_name":"Haddock", "full_name":"Florence Haddock", "title":"Director Sales", "linkedin":"", "facebook":"", "twitter":"", "googleplus":"", "department":"", "do_not_call":false, "phone_home":"(729) 845-3137", "email":[ { "email_address":"[email protected]", "opt_out":"1", "invalid_email":"0", "primary_address":"0" }, {
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefiltercount_GET/index.html
328f6f016a92-7
"primary_address":"0" }, { "email_address":"[email protected]", "opt_out":"0", "invalid_email":"0", "primary_address":"1" } ], "phone_mobile":"(246) 233-1382", "phone_work":"(565) 696-6981", "phone_other":"", "phone_fax":"", "email1":"[email protected]", "email2":"[email protected]", "invalid_email":false, "email_opt_out":false, "primary_address_street":"111 Silicon Valley Road", "primary_address_street_2":"", "primary_address_street_3":"", "primary_address_city":"Denver", "primary_address_state":"CA", "primary_address_postalcode":"79900", "primary_address_country":"USA", "alt_address_street":"", "alt_address_street_2":"", "alt_address_street_3":"", "alt_address_city":"", "alt_address_state":"", "alt_address_postalcode":"", "alt_address_country":"", "assistant":"", "assistant_phone":"", "picture":"", "email_and_name1":"", "lead_source":"Support Portal User Registration", "account_name":"Smallville Resources Inc", "account_id":"d5db6292-5c24-eb61-e202-512d09f0134e", "opportunity_role_fields":"", "opportunity_role_id":"", "opportunity_role":"", "reports_to_id":"", "report_to_name":"",
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefiltercount_GET/index.html
328f6f016a92-8
"reports_to_id":"", "report_to_name":"", "portal_name":"FlorenceHaddock169", "portal_active":true, "portal_password":"$1$nWFhTbK6$JF9BCGSqL\/NCrbhueX5ia0", "portal_password1":"", "portal_app":"", "preferred_language":"en_us", "campaign_id":"", "campaign_name":"", "c_accept_status_fields":"", "m_accept_status_fields":"", "accept_status_id":"", "accept_status_name":"", "sync_contact":"", "my_favorite":false, "_acl":{ "fields":{ } } } ] } Change Log Version Change v10 Added /<module>/filter POST endpoint. Last modified: 2023-02-03 21:04:03
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefiltercount_GET/index.html
9bec2e9911ee-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 { "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 { "id": "8f9cd3d1-ce5d-e8d4-12d8-56cf674d2600", "name": "New Dashboard for Accounts Module",
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboardsmodule_POST/index.html
9bec2e9911ee-1
"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", "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": [], "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
78fc115409c2-0
/<module>/globalsearch GET Overview Global search Summary This endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the /search endpoint. This endpoint can be used with a long list of request arguments. Instead of using GET request arguments, all described arguments can be used inside a JSON encoded request body using a the GET request. If your client has no support for GET requests with a body, the POST method can be used as an alternative. Request Arguments Name Type Description Required q String The search expression. Multiple terms can be specified at once. All enabled fields will be searched in. The results are ordered by relevance which is based on a multitude of settings based on token counts, hit ratio, (weighted) boost values and type of field. Currently no operators are supported in the search expression itself. By refining the search expression more relevant results will be returned as top results. If no search expression is given results are returned based on last modified date. False module_list String Comma delimited list of modules to search. If omitted, all search enabled modules will be queried. Note that when consuming the endpoint /:module/globalsearch that this parameter is ignored. Example: Accounts,Contacts 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 highlights Boolean Wether or not to return highlighted results. Default is true.
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleglobalsearch_GET/index.html
78fc115409c2-1
Wether or not to return highlighted results. Default is true. False sort Array Define the sort order of the results. By default the results are returned by relevance which is the preferred approach. Using this argument any search enabled field can be used to sort on. Keep in mind the not sorting by relevance may have a negative performance impact. Example: {"date_modified":"desc","name":"asc"} False Request { } 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 { } Change Log Version Change v10 Added /globalsearch GET/POST endpoint. v10 Added /:module/globalsearch GET/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/moduleglobalsearch_GET/index.html
fa1c280bbc1d-0
/pmse_Inbox/engine_claim PUT Overview Claims the processes to the current user Summary This endpoint claims the processes to the current user. Request Arguments Name Type Description Required cas_id string The id of the process trigger sequence true cas_index string The step in the process true Response There is no Response to this endpoint Last modified: 2023-02-03 21:04:03
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxengine_claim_PUT/index.html
cfa2326a241a-0
/<module>/prepend/:target POST Overview Append new node to target node as first 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 prepend new node True Request { "name" : "Children Node 1" } Response Arguments This endpoint does not return any response arguments. Response This enpdoint returns a newly created record GUID { "my_favorite":false, "following":"", "id":"59fa8dd7-0f2c-4bfd-364f-54495f77fa3f", "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, "level":1, "_acl":{"fields":{}}, "_module":"Categories" }
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleprependtarget_POST/index.html
cfa2326a241a-1
"_acl":{"fields":{}}, "_module":"Categories" } Change Log Version Change v10 Added /<module>/prepend/: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/moduleprependtarget_POST/index.html
183f12b6157a-0
/pmse_Inbox/:record/file/:field GET Overview Returns the process status image file Summary This endpoint returns the process status image file. Request Arguments Name Type Description Required record string The id of the record or image to get true field string The image type field to get the image from true _project string If set, will get an image for a project instead of a process false Response There is no Response to this endpoint Last modified: 2023-02-03 21:04:03
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxrecordfilefield_GET/index.html
f9756a04e90c-0
/ping GET Overview Responds with "pong" if the access_token is valid. Request Arguments This endpoint does not accept any arguments. Response Arguments Name Type Description <response> String Returns pong is authenticated. Response pong Change Log Version Change v10 Added /ping 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/ping_GET/index.html
860e2ec4b20a-0
/Documents/:record/file/:field PUT Overview This endpoint takes a file or image and saves it to a record that already contains an attachment in the specified field. The PUT method is very similar to the POST method but differs slightly in how the request is constructed. PUT requests should send the file data as the body of the request. Optionally, a filename query parameter can be sent with the request to assign a name. Additionally, the PUT method can accept base64 encoded file data which will be decoded by the endpoint if the content_transfer_encoding parameter is set to 'base64'.NOTE: In lieu of the content_transfer_encoding parameter, a request header of X-Content-Transfer-Encoding can also be sent with a value of 'base64'. In the event both the content transfer encoding header and request parameter are sent, the header will be used. Request Arguments Name Type Description Required filename String Filename to save the document as False content_transfer_encoding String When set to 'base64', indicates the file contents are base64 encoded and will result in the file contents being base64 decoded before being saved False Request PUT /rest/v10/Notes/abcd-1234/file/field/ HTTP/1.1 Host: localhost Connection: keep-alive Content-Length: 23456 Content-Type: application/document-doc ...This is where the bin data would be Response Arguments Name Type Description field Array The fields containing file properties. field.content-type String The files content type. field.content-length Integer The files content length. field.name
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Documentsrecordfilefield_PUT/index.html
860e2ec4b20a-1
Integer The files content length. field.name String The files name. field.width Integer The width of the image. field.height Integer The height of the image. field.uri String The URI of the file. Response { "picture":{ "content-type":"image\/png", "content-length":72512, "name":"1a7b8f5c-b11c-0094-c8d8-512e9daaa983", "width":933, "height":519, "uri":"http:\/\/sugarcrm\/rest\/v10\/Contacts\/fa300a0e-0ad1-b322-9601-512d0983c19a\/file\/picture" } "attachment":{ "content-type":"application/document-doc", "content-length":"873921", "name":"myFile.doc", "uri": "http:\/\/sugarcrm\/rest\/v10\/Contacts\/f2f9aa4d-99a8-e86e-f4d5-512d0986effa\/file\/attachment" } } Change Log Version Change v10 Added /<module>/:record/file/:field 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/Documentsrecordfilefield_PUT/index.html
8177ffa5392f-0
/<module>/:record/file GET Overview Lists all populated fields of type "file" or of type "image" for a record. Request Arguments This endpoint does not accept any request arguments. Response Arguments Name Type Description field Array The fields containing file properties. field.content-type String The files content type. field.content-length Integer The files content length. field.name String The files ID. field.width Integer The width of the image. field.height Integer The height of the image. field.uri String The URI of the file. Response { "picture":{ "content-type":"image\/png", "content-length":72512, "name":"1a7b8f5c-b11c-0094-c8d8-512e9daaa983", "width":933, "height":519, "uri":"http:\/\/sugarcrm\/rest\/v10\/Contacts\/fa300a0e-0ad1-b322-9601-512d0983c19a\/file\/picture" }, "record": { "my_favorite": false, "following": true, "id": "fa300a0e-0ad1-b322-9601-512d0983c19a", "name": "Test",
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfile_GET/index.html
8177ffa5392f-1
"name": "Test", "date_modified": "2014-05-16T03:49:12+02:00", "modified_user_id": "1", "modified_by_name": "admin", "created_by": "1", "created_by_name": "Administrator", "doc_owner": "1", "description": "", "deleted": false, "assigned_user_id": "1", "assigned_user_name": "Administrator", "team_count": "", "team_name": [ { "id": 1, "name": "Global", "name_2": "", "primary": true } ], "email": [], "email1": "", "email2": "", "invalid_email": "", "email_opt_out": "", "email_addresses_non_primary": "", "salutation": "", "first_name": "", "last_name": "Test", "full_name": "Test", "title": "", "facebook": "", "twitter": "", "googleplus": "", "department": "", "do_not_call": false, "phone_home": "", "phone_mobile": "", "phone_work": "", "phone_other": "", "phone_fax": "", "primary_address_street": "", "primary_address_city": "", "primary_address_state": "", "primary_address_postalcode": "", "primary_address_country": "", "alt_address_street": "", "alt_address_city": "", "alt_address_state": "", "alt_address_postalcode": "",
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfile_GET/index.html
8177ffa5392f-2
"alt_address_state": "", "alt_address_postalcode": "", "alt_address_country": "", "assistant": "", "assistant_phone": "", "picture": "", "email_and_name1": "", "lead_source": "", "account_name": "", "account_id": "", "dnb_principal_id": "", "opportunity_role_fields": "", "opportunity_role_id": "", "opportunity_role": "", "reports_to_id": "", "report_to_name": "", "birthdate": "", "portal_name": "", "portal_active": false, "portal_password": null, "portal_password1": null, "portal_app": "", "preferred_language": "en_us", "campaign_id": "", "campaign_name": "", "c_accept_status_fields": "", "m_accept_status_fields": "", "accept_status_id": "", "accept_status_name": "", "accept_status_calls": "", "accept_status_meetings": "", "sync_contact": false, "mkto_sync": false, "mkto_id": null, "mkto_lead_score": null, "_acl": { "fields": {} }, "_module": "Contacts" } } Change Log Version Change v10 Added /<module>/:record/file 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/modulerecordfile_GET/index.html
63e81d3426b5-0
/pmse_Business_Rules/:record/brules GET Overview Exports a .pbr file with a Process Business Rules definition Summary This endpoint will retrieve a .pbr file containing JSON encoded data of a Process Business Rules definition identified by the record input parameter. Request Arguments Name Type Description Required record String The Process Business Rule record ID True Response Arguments Name Type Description N/A Response Note: The response is a MIME type application/pbr file attachment without any response parameters. 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_Business_Rulesrecordbrules_GET/index.html
c8218f829dfd-0
/<module>/:record/link/activities GET Activities on a module's list view Summary: This endpoint lists activities across a particular module in the system. It does not use a subscription model unlike the other endpoints. It can be queried as a regular 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", "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, "data": [] },
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinkactivities_GET/index.html
c8218f829dfd-1
"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/modulerecordlinkactivities_GET/index.html
7d1781516414-0
/<module>/: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/modulerecordfilefield_POST/index.html
7d1781516414-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/modulerecordfilefield_POST/index.html
8c86de151c51-0
/Contacts/:record/freebusy GET Get a contact's FreeBusy schedule Summary: This endpoint returns a list of time slots for which the specified person is busy. Request GET /Contacts/: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/Contactsrecordfreebusy_GET/index.html
803770c04e68-0
/TimePeriods/:date GET Return a Timeperiod by a given date Summary: This endpoint is used to get a TimePeriod for a given date. If one is not found a 404 is returned. Output Example: { "id":"e394485a-5889-ea75-84c8-51543bd1a5ba", "name":"Q1 (01\/01\/2013 - 03\/31\/2013)", "parent_id":"e28efe2d-c51c-be45-3d84-51543b4d2910", "start_date":"2013-01-01", "start_date_timestamp":"1356998400", "end_date":"2013-03-31", "end_date_timestamp":"1364774399", "created_by":"1", "date_entered":"2013-03-28 12:46:36", "date_modified":"2013-03-28 12:46:36", "deleted":"0", "is_fiscal":"0", "is_fiscal_year":"0", "leaf_cycle":"1", "type":"Quarter", "related_timeperiods":"" } Last modified: 2023-02-03 21:04:03
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriodsdate_GET/index.html
938cd94ce397-0
/logger POST Overview Logs a message to the Sugar Log Request Arguments Name Type Description Required level String The log level True message String The message to log True channel String Prefix for the log message, defaults to Main false Response Arguments Name Type Description status bool if the message was logged Response { "status":true, } Change Log Version Change v10 Added /logger 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/logger_POST/index.html
ae9e8cf76a4c-0
/<module>/:record/vcard GET Overview Downloads a vCard. Request Arguments This endpoint does not accept any arguments. Response Arguments Name Type Description <vcard information> String; Record in vcard format Response BEGIN:VCARD N;CHARSET=utf-8:Leone;Rosemarie;; FN;CHARSET=utf-8: Rosemarie Leone BDAY: TEL;WORK;FAX: TEL;HOME;CHARSET=utf-8:(692) 586-8287 TEL;CELL;CHARSET=utf-8:(117) 577-0969 TEL;WORK;CHARSET=utf-8:(844) 325-7679 EMAIL;INTERNET;CHARSET=utf-8:[email protected] ADR;WORK;CHARSET=utf-8:;;777 West Filmore Ln;San Mateo;CA;74984;USA ORG;CHARSET=utf-8:Q.R.&E. Corp; TITLE;CHARSET=utf-8:Director Sales END:VCARD } Change Log Version Change v10 Added /<module>/:record/vcard GET endpoint. Last modified: 2023-02-03 21:04:03
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordvcard_GET/index.html
8790b76e61ff-0
/PdfManager GET Overview Lists filtered records. Summary This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id. If both a filter definition and a filter id are passed, the two filters will be joined with an AND. Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as: "link_name.remote_field", so if you wished to search the Accounts module by a related member account you would use "members.sic_code". Request Arguments Name Type Description Required filter String 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/PdfManager_GET/index.html
8790b76e61ff-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/PdfManager_GET/index.html
8790b76e61ff-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/PdfManager_GET/index.html
8790b76e61ff-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/PdfManager_GET/index.html
8790b76e61ff-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/PdfManager_GET/index.html
8790b76e61ff-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/PdfManager_GET/index.html
1c6b0af2153b-0
/Leads/register POST Overview Creates new Leads. Request Arguments Name Type Description Required <record field> <record field type> The name value list of fields to populate. True Request { "first_name":"John", "last_name":"Smith" } Response Arguments Name Type Description <record field> <record field type> Returns the fields for the newly created record. Response { "id":"ecba9f86-4a4a-def6-359c-505a5b33f014", "name":"John Smith", "date_entered":"2012-09-19T23:54:54+0000", "date_modified":"2012-09-19T23:54:54+0000", "modified_user_id":"1", "created_by":"1", "deleted":0, "team_id":"1", "team_set_id":"1", "first_name":"John", "last_name":"Smith", "full_name":"John Smith", "do_not_call":false, "converted":false, "lead_source":"Support Portal User Registration", "status":"New", "preferred_language":"en_us", "email":[ ], "my_favorite":false } Change Log Version Change v10 Added /Leads/register 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/Leadsregister_POST/index.html
7e85ea45f8d1-0
/<module>/MassUpdate DELETE Overview An API to mass delete records. Query String Parameters Name Type Description Required massupdate_params Array Mass update parameters. True massupdate_params.uid Array A list of ids. True Request Mass Deleting Records by ID in a Module { "massupdate_params":{ "uid":[ "ebf22b86-94ea-1601-4f4f-512d09173438", "e3b71c55-d96b-80bb-1696-512d09672398" ] } } Response Arguments Name Type Description Status String The status of the mass update. Possible value is 'done'. Output Done Example { "status":"done" } Change Log Version Change v10 Added /<module>/MassUpdate 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/moduleMassUpdate_DELETE/index.html
c8456202a3f1-0
/<module>/record_list POST Overview An API to create and save lists of records. Summary Create record list. Only POST request allowed. Request Arguments Name Type Description Required module string Module name True records array Array of records True Request Example POST /rest/v10/:module/record_list {records: ["e5c8bb3b-5eea-3d8a-c278-56c6affa6212", "e49395b4-d3b0-1e3f-600a-56c6afe7e34f"]} Response Arguments Name Type Description id guid record list id assigned_user_id guid user id module_name string Module name records array record ids date modified date date modified Output Example { "id": "39d2c781-c0b7-446f-1d83-56c6e3cda510", "assigned_user_id": "1", "module_name": "Accounts", "records": [ "e5c8bb3b-5eea-3d8a-c278-56c6affa6212", "e49395b4-d3b0-1e3f-600a-56c6afe7e34f", "c03ed8ee-60d3-c6a6-55c3-56c6af95e696", "d65573e3-c25a-f9b4-33f2-56c6afb8d856" ],
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_list_POST/index.html
c8456202a3f1-1
], "date_modified": "2016-02-19 09:42:44" } Last modified: 2023-02-03 21:04:03
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_list_POST/index.html
b6e40198dcd5-0
/<module>/config GET Overview Retrieves the config settings for a given module. Summary This endpoint is normally used for the forecasting module. Request Arguments This endpoint does not accept any request arguments. Response Arguments Name Type Description <config field> <config field type> The list of config fields will be returned. Response { "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 } }, "show_custom_buckets_ranges":{ "include":{ "min":85, "max":100 }, "upside":{ "min":70, "max":84 }, "exclude":{ "min":0,
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleconfig_GET/index.html
b6e40198dcd5-1
}, "exclude":{ "min":0, "max":69 } }, "sales_stage_won":[ "Closed Won" ], "sales_stage_lost":[ "Closed Lost" ], "show_worksheet_likely":1, "show_worksheet_best":1, "show_worksheet_worst":0, "show_projected_likely":1, "show_projected_best":1, "show_projected_worst":0, "show_forecasts_commit_warnings":1 } Change Log Version Change v10 Added /<module>/config 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/moduleconfig_GET/index.html
fdaf05f956e5-0
/ForecastManagerWorksheets/assignQuota POST Assign Quotas to All Reporting Users for a given timeperiod Summary: This endpoint is used to assign out the quota to the reporting users with out having to commit a forecast. Parameters: Param Description Optional user_id The Manager's user id for who is assigning out the quota false timeperiod_id Which timeperiod are we assigning quota for false Input Example: { "user_id" : "seed_sarah_id", "timeperiod_id" : "36f7085a-5889-ea75-84c8-50f42bd1a5ba" } Output Example: {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/ForecastManagerWorksheetsassignQuota_POST/index.html
57aef0f54958-0
/Forecasts/enum/selectedTimePeriod GET ForecastsApi Timeperiod filter info Summary: This returns the timeperiods with respect to the forward/backward options selected. For example, if we elect to use quarterly timeperiods and 2 forward and 2 backward timeperiod intervals are set, then 5 years worth of timeperiods will be returned (2 backward + current + 2 forward). Query Parameters: Param Description Optional This endpoint does not accept any parameters. Input Example: Output Example: { "d181230a-a7e0-3176-d10f-50f8530a51ce" : "Q1 (01/01/2012 - 03/31/2012)", "d2bc58ef-21c4-27d5-e416-50f853db29f9" : "Q2 (04/01/2012 - 06/30/2012)", "d3db853e-94d6-b5ac-98af-50f8530689be" : "Q3 (07/01/2012 - 09/30/2012)", "d519f521-5303-1cfc-24f5-50f8537f5b54" : "Q4 (10/01/2012 - 12/31/2012)", "dcc2885a-5889-ea75-84c8-50f853d1a5ba" : "Q1 (01/01/2013 - 03/31/2013)", "ddc24224-c6c9-04aa-7869-50f853db2ea2" : "Q2 (04/01/2013 - 06/30/2013)",
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastsenumselectedTimePeriod_GET/index.html
57aef0f54958-1
"deadcfd3-41ed-5f6b-ce5b-50f853de6ef6" : "Q3 (07/01/2013 - 09/30/2013)", "dfaa3724-6295-8ddb-6d14-50f853047fcc" : "Q4 (10/01/2013 - 12/31/2013)", "e1ceee19-c8dd-afdd-e797-50f8538d900a" : "Q1 (01/01/2014 - 03/31/2014)", "e307594a-c12a-6be6-74b7-50f85351c574" : "Q2 (04/01/2014 - 06/30/2014)", "e469239c-3f71-a48e-cda1-50f853214b6a" : "Q3 (07/01/2014 - 09/30/2014)", "e57f4889-cefd-4356-6d82-50f85350decd" : "Q4 (10/01/2014 - 12/31/2014)" } 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/ForecastsenumselectedTimePeriod_GET/index.html
ec616064e070-0
/<module>/customfield POST Overview Create a new custom field for a specified module. Summary This endpoint is used to create a new custom field for a specified module. Request Arguments Name Type Description Required data array The field metadata. True Request Examples This example will create a decimal type custom field: { "localizations": { "en_us": { "LBL_AI_SCORE": "Ai Score" }, ... }, "data":{ "name":"ai_score", "label":"LBL_AI_SCORE", "type":"decimal", "len":"18", "precision":8, "required":false, "reportable":false, "audited":false, "importable":false, "duplicate_merge":false } } This example will create a textField type custom field: { "localizations": { "en_us": { "LBL_AI_SCORE_DESC": "Ai Score Description" }, ... }, "data":{ "name":"ai_score_desc", "label":"LBL_AI_SCORE_DESC", "type":"varchar", "help":"Text Field Help Text", "comments":"Text Field Comment Text", "default_value":"", "len":255, "required":false, "reportable":true, "audited":false, "importable":"true", "duplicate_merge":false } } This example will create an enum type custom field with a new dropdown list: { "localizations": { "en_us": { "LBL_DROPDOWN_FIELD": "New Dropdown Field",
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulecustomfield_POST/index.html
ec616064e070-1
"en_us": { "LBL_DROPDOWN_FIELD": "New Dropdown Field", "LBL_DD_ITEM_ONE": "First Text", "LBL_DD_ITEM_TWO": "Second Text", "LBL_DD_ITEM_THREE": "Third Text" }, ... }, "data": { "name":"new_dropdown_field", "label":"LBL_DROPDOWN_FIELD", "type":"enum", "options": { "dropdownName": "a_new_dropdown", "dropdownList": [ {"value":"First", "label":"LBL_DD_ITEM_ONE"}, {"value":"Second", "label":"LBL_DD_ITEM_TWO"}, {"value":"Third", "label":"LBL_DD_ITEM_THREE"} ] }, "default_value":"First" } } This example will create an enum type custom field using an existing dropdown list: { "localizations": { "en_us": { "LBL_DROPDOWN_FIELD": "New Dropdown Field" }, ... }, "data": { "name":"new_dropdown_field", "label":"LBL_DROPDOWN_FIELD", "type":"enum", "options": "account_type_dom", "default_value":"Analyst" } } Response { "duplicate_merge_dom_value": 0, "required": false, "source": "custom_fields", "name": "ai_score_c", "vname": "LBL_AI_SCORE", "type": "decimal", "massupdate": false, "hidemassupdate": false, "no_default": false, "comments": "", "help": "",
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulecustomfield_POST/index.html
ec616064e070-2
"no_default": false, "comments": "", "help": "", "importable": "", "duplicate_merge": "disabled", "audited": false, "reportable": false, "unified_search": false, "merge_filter": "disabled", "pii": false, "calculated": false, "len": 18, "size": "20", "enable_range_search": false, "precision": "8", "id": "ca9653de-0976-11eb-a558-6c400895ea84", "custom_module": "Opportunities" } Change Log Version Change v11.11 Added /<module>/customfield POST endpoint. Last modified: 2023-02-03 21:04:03
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulecustomfield_POST/index.html
a0b31ee398d7-0
/<module>/:record/file/:field DELETE Overview Removes an attachment from a field for a record and subsequently removes the file from the file system. Request Arguments This endpoint does not accept any request arguments. Response Arguments Name Type Description field Array The fields containing file properties. field.content-type String The files content type. field.content-length Integer The files content length. field.name String The files ID. field.width Integer The width of the image. field.height Integer The height of the image. field.uri String The URI of the file. Response { "picture":{} } Change Log Version Change v10 Added /<module>/:record/file/:field 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/modulerecordfilefield_DELETE/index.html
45139bb36d5c-0
/KBContents/config PUT Creates and/or updates the config settings for the KBContents module Summary: This endpoint is used to create and/or update the config settings for the KBContents module as json data. It extends the core config endpoint by adding the functionality to process deleted languages and documents related to them. Query Parameters: Param Description Optional Input Example: { "languages":[{ "en":"English", "primary":true },{ "de":"German", "primary":false }], "category_root":"31696245-0438-ff7a-9144-544f8c659daf", "deleted_languages":["es","ru"] } Output Example: { "languages":[{ "en":"English", "primary":true },{ "de":"German", "primary":false }], "category_root":"31696245-0438-ff7a-9144-544f8c659daf", "deleted_languages":["es","ru"] } 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/KBContentsconfig_PUT/index.html
cafb9669f6f3-0
/<module>/:record GET Overview Retrieves a record. 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 selected record. Response { "id":"bdd59d85-687b-1739-b00a-512d09f6db9e", "name":"Insight Marketing Inc", "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-26T19:12: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":1, "name":"Global", "name_2":"", "primary":false }, { "id":"West", "name":"West", "name_2":"", "primary":true } ], "linkedin":"", "facebook":"", "twitter":"", "googleplus":"", "account_type":"Customer",
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_GET/index.html
cafb9669f6f3-1
"googleplus":"", "account_type":"Customer", "industry":"Electronics", "annual_revenue":"", "phone_fax":"", "billing_address_street":"345 Sugar Blvd.", "billing_address_street_2":"", "billing_address_street_3":"", "billing_address_street_4":"", "billing_address_city":"San Mateo", "billing_address_state":"CA", "billing_address_postalcode":"56019", "billing_address_country":"USA", "rating":"", "phone_office":"(927) 136-9572", "phone_alternate":"", "website":"www.sectionvegan.de", "ownership":"", "employees":"", "ticker_symbol":"", "shipping_address_street":"345 Sugar Blvd.", "shipping_address_street_2":"", "shipping_address_street_3":"", "shipping_address_street_4":"", "shipping_address_city":"San Mateo", "shipping_address_state":"CA", "shipping_address_postalcode":"56019", "shipping_address_country":"USA", "email1":"[email protected]", "parent_id":"", "sic_code":"", "parent_name":"", "email_opt_out":false, "invalid_email":false, "email":[ { "email_address":"[email protected]", "opt_out":"0", "invalid_email":"0", "primary_address":"1" }, { "email_address":"[email protected]", "opt_out":"0", "invalid_email":"0",
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_GET/index.html
cafb9669f6f3-2
"opt_out":"0", "invalid_email":"0", "primary_address":"0" } ], "campaign_id":"", "campaign_name":"", "my_favorite":false, "_acl":{ "fields":{ } } } Change Log Version Change v10 Added /<module>/:record 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/modulerecord_GET/index.html
7feae5c8e12a-0
/Cases/clients/portal PUT Overview [ADMIN] Set a case as 'Requested For Close' Summary This endpoint sets a case as 'Requested for Close' in the portal on a Sugar Serve instance. Request Arguments This endpoint does not accept any arguments. Response Arguments Name Type Description <record field> <record field type> Returns the fields for the updated Cases record. Response { "id":"d6582610-d69b-11ea-afe4-acde48001122", "name":"Need to purchase additional licenses", "date_entered":"2020-08-04T21:44:16+00:00", "date_modified":"2020-08-04T21:56:03+00:00", "modified_user_id":"19dc0582-d69c-11ea-95e6-acde48001122", "modified_by_name":"Sugar Customer Support Portal ", "created_by":"1", "created_by_name":"Administrator", "description":"", "deleted":false, "case_number":150, "type":"Product", "status":"Pending Input", "priority":"P2", "resolution":"", "work_log":"", "follow_up_datetime":"", "widget_follow_up_datetime":"", "resolved_datetime":"", "hours_to_resolution":null, "business_hours_to_resolution":null, "pending_processing":false, "account_name":"Gifted Holdings AG", "business_center_id":"", "source":"", "request_close":true, "request_close_date":"2020-08-04T21:56:03+00:00",
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Casesclientsportal_PUT/index.html
7feae5c8e12a-1
"portal_viewable":true, "widget_status":"", "primary_contact_name":"", "team_count":"", "team_name":[{"id":"West","name":"West","name_2":"","primary":true,"selected":false}], "first_response_target_datetime":"", "first_response_actual_datetime":"", "hours_to_first_response":null, "business_hrs_to_first_response":null, "first_response_var_from_target":null, "first_response_sla_met":"", "first_response_user_id":"", "first_response_user_name":"", "first_response_sent":false, "_acl":{"edit":"no","create":"no","fields":{}},"_module":"Cases" } Change Log Version Change v11_10 Added /Cases/clients/portal 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/Casesclientsportal_PUT/index.html
95be73fd03c7-0
/Administration/idm/migration/disable POST Overview [ADMIN] Disable Idm migrations Summary This endpoint disables Idm migrations. This endpoint is only available to administrators. Request Arguments This endpoint does not accept any arguments. Response { "success": true } Change Log Version Change v11_2 Added Administration/idm/migration/disable 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/Administrationidmmigrationdisable_POST/index.html
d84e772baf8f-0
/Calls 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/Calls_POST/index.html
a38a097b3526-0
/<module>/:record/file/:field PUT Overview This endpoint takes a file or image and saves it to a record that already contains an attachment in the specified field. The PUT method is very similar to the POST method but differs slightly in how the request is constructed. PUT requests should send the file data as the body of the request. Optionally, a filename query parameter can be sent with the request to assign a name. Additionally, the PUT method can accept base64 encoded file data which will be decoded by the endpoint if the content_transfer_encoding parameter is set to 'base64'.NOTE: In lieu of the content_transfer_encoding parameter, a request header of X-Content-Transfer-Encoding can also be sent with a value of 'base64'. In the event both the content transfer encoding header and request parameter are sent, the header will be used. Request Arguments Name Type Description Required filename String Filename to save the document as False content_transfer_encoding String When set to 'base64', indicates the file contents are base64 encoded and will result in the file contents being base64 decoded before being saved False Request PUT /rest/v10/Notes/abcd-1234/file/field/ HTTP/1.1 Host: localhost Connection: keep-alive Content-Length: 23456 Content-Type: application/document-doc ...This is where the bin data would be Response Arguments Name Type Description field Array The fields containing file properties. field.content-type String The files content type. field.content-length Integer The files content length.
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfilefield_PUT/index.html
a38a097b3526-1
Integer The files content length. field.name String The files name. field.width Integer The width of the image. field.height Integer The height of the image. field.uri String The URI of the file. Response { "picture":{ "content-type":"image\/png", "content-length":72512, "name":"1a7b8f5c-b11c-0094-c8d8-512e9daaa983", "width":933, "height":519, "uri":"http:\/\/sugarcrm\/rest\/v10\/Contacts\/fa300a0e-0ad1-b322-9601-512d0983c19a\/file\/picture" } "attachment":{ "content-type":"application/document-doc", "content-length":"873921", "name":"myFile.doc", "uri": "http:\/\/sugarcrm\/rest\/v10\/Contacts\/f2f9aa4d-99a8-e86e-f4d5-512d0986effa\/file\/attachment" } } Change Log Version Change v10 Added /<module>/:record/file/:field 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/modulerecordfilefield_PUT/index.html
69a008ecc91a-0
/Teams/: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/Teamsrecordlinklink_nameremote_id_DELETE/index.html
69a008ecc91a-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/Teamsrecordlinklink_nameremote_id_DELETE/index.html
69a008ecc91a-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/Teamsrecordlinklink_nameremote_id_DELETE/index.html
69a008ecc91a-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/Teamsrecordlinklink_nameremote_id_DELETE/index.html
69a008ecc91a-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/Teamsrecordlinklink_nameremote_id_DELETE/index.html
534e464fb325-0
/<module>/:record/file/:field GET Overview Retrieves an attached file for a specific field on a record. Request Arguments This endpoint does not accept any request arguments. Response Arguments The response from this request is an HTTP response with a forced download. This can be used in rendering images through the API or in offering immediate file downloads. Response Cache-Control: no-cache, must-revalidate Connection: keep-alive Content-Encoding: gzip Content-Type: application/octet-stream Date: Mon, 30 Jan 2012 17:00:46 GMT Expires: Mon, 30 Jan 2012 17:00:45 GMT Last-Modified: Thu, 10 Nov 2011 19:01:31 GMT Transfer-Encoding: chunked Vary: Accept-Encoding... Change Log Version Change v10 Added /<module>/:record/file/:field GET endpoint. Last modified: 2023-02-03 21:04:03
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfilefield_GET/index.html
c766660bfe2f-0
/pmse_Inbox/ReassignForm PUT Overview Deprecated endpoint. Summary This endpoint is deprecated and will be removed in a future release. Last modified: 2023-02-03 21:04:03
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxReassignForm_PUT/index.html
c754e95965e7-0
/Mail/recipients/lookup POST Overview Accepts an array of one or more recipients and tries to resolve unsupplied arguments to provide more comprehensive data for the recipient(s). Request [ { "module": "Contacts", "id": "962cefa8-2f1f-11e6-9ade-80e6500b09a0", "email": "", "name": "" }, { "module": "Leads", "id": "9c61c46a-a7c5-df71-481c-51d48232f820", "email": "", "name": "Vince Tallion" } ] Response [ { "module": "Contacts", "id": "962cefa8-2f1f-11e6-9ade-80e6500b09a0", "email": "[email protected]", "name": "Kelly Germaine", "resolved": true }, { "module": "Leads", "id": "9c61c46a-a7c5-df71-481c-51d48232f820", "email": "[email protected]", "name": "Vince Tallion", "resolved": true } ] Change Log Version Change v11 Last version in which /Mail/recipients/lookup POST is available. v10 Added /Mail/recipients/lookup 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/Mailrecipientslookup_POST/index.html
d36bead58f23-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 DELETE Overview Removes 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, and those records are related, then remove the relationship of 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"
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_DELETE/index.html
d36bead58f23-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 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/Integratemodulelhs_sync_key_field_namelhs_sync_key_field_valuelinklink_namerhs_sync_key_field_namerhs_sync_key_field_value_DELETE/index.html
0995a4d04fbc-0
/Administration/config/:category POST Overview [ADMIN] Set Configuration Settings for a Category. Summary This endpoint sets configuration values for a given category. This endpoint is only available to administrators. Request POST /Administration/config/:category   Response Example { "a_config": "good" } Change Log Version Change v11.13 Added Administration/config/:category 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/Administrationconfigcategory_POST/index.html
4da2cbdae419-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
bf1ddc49b355-0
/Meetings/: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/Meetingsrecord_DELETE/index.html
5beb81b90f02-0
/<module>/record_list/:record_list_id GET Overview An API to return record list data Summary Get record list data. Only GET request allowed. Request Arguments Name Type Description Required module string Module name True record_list_id guid record list id True Request Example GET /rest/v10/:module/record_list/:id Response Arguments Name Type Description id guid record list id assigned_user_id guid user id module_name string Module name records array record ids date modified date date modified Output Example { "id": "39d2c781-c0b7-446f-1d83-56c6e3cda510", "assigned_user_id": "1", "module_name": "Accounts", "records": [ "e5c8bb3b-5eea-3d8a-c278-56c6affa6212", "e49395b4-d3b0-1e3f-600a-56c6afe7e34f", "c03ed8ee-60d3-c6a6-55c3-56c6af95e696", "d65573e3-c25a-f9b4-33f2-56c6afb8d856" ], "date_modified": "2016-02-19 09:42:44" } Last modified: 2023-02-03 21:04:03
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_listrecord_list_id_GET/index.html