id
stringlengths 14
16
| text
stringlengths 33
5.27k
| source
stringlengths 105
270
|
|---|---|---|
f57b42676707-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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfavorite_PUT/index.html |
f57b42676707-2 | },
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"linkedin":"",
"facebook":"",
"twitter":"",
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfavorite_PUT/index.html |
f57b42676707-3 | "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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfavorite_PUT/index.html |
f57b42676707-4 | "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",
"primary_address":"0"
}
], | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfavorite_PUT/index.html |
f57b42676707-5 | "primary_address":"0"
}
],
"campaign_id":"",
"campaign_name":"",
"my_favorite":true,
"_acl":{
"fields":{
}
}
}
Change Log
Version
Change
v10
Added /<module>/:record/favorite 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/modulerecordfavorite_PUT/index.html |
948eae91f413-0 | /Forecasts GET
Overview
Updates a record of a specified type as a favorite for the current user.
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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecasts_GET/index.html |
948eae91f413-1 | "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":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecasts_GET/index.html |
948eae91f413-2 | "name":"West",
"name_2":"",
"primary":true
}
],
"linkedin":"",
"facebook":"",
"twitter":"",
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecasts_GET/index.html |
948eae91f413-3 | "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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecasts_GET/index.html |
948eae91f413-4 | "shipping_address_country":"USA",
"email1":"[email protected]",
"parent_id":"",
"sic_code":"",
"parent_name":"",
"email_opt_out":false,
"invalid_email":false,
"email":[
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"0"
}
],
"campaign_id":"",
"campaign_name":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecasts_GET/index.html |
948eae91f413-5 | ],
"campaign_id":"",
"campaign_name":"",
"my_favorite":true,
"_acl":{
"fields":{
}
}
}
Change Log
Version
Change
v10
Added /<module>/:record/favorite 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/Forecasts_GET/index.html |
d9a167f74649-0 | /me/preference/:preference_name PUT
Overview
Updates a specific preference for the current user.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
Â
Â
Â
Response
{
}
Change Log
Version
Change
v10
Added /me/preference/:preference_name PUT endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/mepreferencepreference_name_PUT/index.html |
397c71532ea2-0 | /<module>/temp/file/:field/:temp_id GET
Overview
Reads a temporary image and deletes it.
Request Arguments
This endpoint does not accept any arguments.
Response Arguments
Name
Type
Description
<image file>
String;
Returns the image content with the content headers.
Response
result: HTTP/1.1 200 OK
Date: Fri, 01 Mar 2013 05:36:24 GMT
Server: Apache/2.2.22 (Unix) DAV/2 PHP/5.3.17
X-Powered-By: PHP/5.3.17
Expires: Sun, 31 Mar 2013 05:36:24 GMT
Cache-Control: max-age=1, post-check=0, pre-check=0
Pragma: public | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
397c71532ea2-1 | Pragma: public
X-Content-Type-Options: nosniff
Content-Length: 2072
ETag: d41d8cd98f00b204e9800998ecf8427e
Connection: close
Content-Type: image/png
â°PNG | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
397c71532ea2-2 | IHDRIIqsÃÃIDATxÅÃÅ}hUçÃ?¿âºÃ«iÃlâ¹Ã¹Ãë⤩â¢Å¡S'âDâÃÃ4+ËÃv¸Â±ÂMö['vl°¹wêÃÂâmÅMÅ Ãâ¦jBWDD$ÃâËdR²L$Ë | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
397c71532ea2-3 | âËdR²L$ËË/!^sï9çùÃÂç^st7ÃcrÃÞ\î%ÃÅû¾çy¹y~ÂËËËËêA*Ãâ¬Âx"÷r!°pâ¬p | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
397c71532ea2-4 | H¬ÿwEÃâ£b'BrjÂ6`°h®ÿŽçÂi¨Å¬²J
â°IMX)ŸÃ>?
$Co÷ à ß}ž"WXY$ÃwKµcSà ¬Ã&éA¤â¬Ãdæ«l·bI%eÃ¥$â¬Ã¥ÃF X4fþ°à | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
397c71532ea2-5 | pâºÂ®"Ã%Ã"RVÃ%â¦RS¬ÃŠéZâ°âš¨L£Ã¤ë0Ã
OWÃ$â¦RÃlÃÃYâ¡Â±æ'š¨à *p+ë`Å"¦k^'B©ù(v¬éºÂâ¢75Qâ¢Ãæ«âºÂ®IË_ºæ$)+'â°M | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
397c71532ea2-6 | IË_ºæ$)+'â°MM'ø">5Q1ÃuÃà ïÃ6]þ\dEâJM=v¬é¶`Sã6]CÃQ`¸ ÃÃõ@I¡Ã´`¥äRÃ@u¤&*»HÃŽ]ÆDLWAI#·$ùº | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
397c71532ea2-7 | ÃXý¾÷+`ÃâÂWÃ/ÃúæâIX PµŸX®JRâ¹ÃÃà êÃOâ{IÃ|û¬Irà ÅW®M5|Ãh§'ôXÂJ#BB] | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
397c71532ea2-8 | ðÂ5¨ÃÃ
¨ï÷éÃâé¡Ã_âÅŸÃúOåýü}tð)Êòt ü'â¬Ã÷ÃãÃSâ¢Ã¥iè | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
397c71532ea2-9 | '6EkAªVâª"vscŽúìÃq}vg3¾ÃE4 AdÃ+ªÂ¤ÃÃâ¬Âµj½ UNgãµÃâ¢7n'âu=è5ÃzÃnP«"]¶>ªÃi'¬Ã@&ÃÆê:±âºl°Kâ¦/£ù$âÂe'õâ¹Ã¨ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
397c71532ea2-10 | Âe'õâ¹Ã¨Å½G"ë0ºwIÃqý»ngöö¦ÃMµé'vUæLâ¢KË¢šÃË~s\¿üÃâîøB+~ð5 ¼n¯UTäžâ5a'Â¥Ã|Ã.$Ãd!jÂÃIhWÃsdáâS¯-\p"©~éfê | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
397c71532ea2-11 | S¯-\p"©~éfêµOÃõâ¦ÃY4iö3J,ÃÃK | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
397c71532ea2-12 | 'ñü~mþäËyù¥âÃÃlÃKÿP2⢠| https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
397c71532ea2-13 | ¨.âºÃ©Ãÿµ&O_gËÃtžxTDv8ªÃ.~¯aÃqúzîd¾ûÃTºÃÆÃ@ìV¤înçñ¡9lrt | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
397c71532ea2-14 | !ú@þsâ¢ÃnlÃóöJà ux+Ã
ÃdùÃD¦(kqâ¬Â¶Â¬r"=µÃéþZ§/©úÃ/nÂ¥7ùà | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
397c71532ea2-15 | Þ@d°|^éRõÂ1Q=EôëÃæasà 7u'LlÃÃôÂN¯´Ã.oæ!'GQâ âeÃÃnâ±}â¹ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
397c71532ea2-16 | zðÃgÃþoMN7ÃÃÃÃâ¢Â±>§jîäfÃâºÃyâà Ë&jâ ôÃ/^ç©5mxÃób¼-dh¾âº(Å Å%[=gÃÃ*Jâ¹Æ>sÃIžÃµô#}5ª?¿â¢zýqôûHo | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
397c71532ea2-17 | lÅ¡'án©â}Â1žÆïÃÃ'Ãâ¢Â¿jas65.ª | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
397c71532ea2-18 | 2ó¡%éK÷*$Y*ÃènA{añ¢Ãô¯Nû?z~òN½ÃV]F¤I²-tÅ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
397c71532ea2-19 | 8¡ÃäÃúÃý7ùTkâ¢Ã´>ñÃ[¢jÃ^"1aJ.)Ãâ¦Â»Ã©ââGT¿xé9»{iÃâ°Â¤2øÃ[©?7ùf¡/R+ž?Ã"-SæÃ?k"'èÃּHO¯ÃúÃÃ
JÃô»Td³ªÂ'zÂNà| https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
397c71532ea2-20 | d³ªÂ'zÂNìðÂ/ÃCäÃWvî4]Ã]IRwöøÃ_âºÃ¯Â¶Â³ÅbÃTä«Ž{»*IiIÃþc6Â¥oÃ@n§¶Ë1?ÃD'ËTLTÃ÷AMªºÃqÅ:`"Ââ¢Â¦Å¡$¬â`vâ¹P5Tâ¢$µ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
397c71532ea2-21 | `vâ¹P5Tâ¢$µÂªjTaƪ'XRbIË%E | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
397c71532ea2-22 | âÂXRbIË%E âÂXRbIË%E âÂXRbIË%E âÂXRbI($éÃ&pÃþáSà ÃßlM]> | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
397c71532ea2-23 | IÃ
žsþ0ð¶T,/â¦$]bâ¹[>Ã\^¡@?óJ~7÷òoÃXÃâ¢"7®ÃLctöoBþ"·P | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
397c71532ea2-24 | IYQ>ðGlÃÃìÃ
®µ©å%WTø&ðMlçŸ6Aðâ¬S%YQÃu;.ÂÃÃúuc«"*Q²õ°LcÃÿ¶jiâlâ°W!99"½ Ã~"®Ãq[Ãy[2Ãâ¹-Ãâ¢kÃh©â¢öaKQ/&Å Ë0}>)wºnÃvöà | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
397c71532ea2-25 | Ë0}>)wºnÃvöû+÷·`'+Ã
vfÃŽÂ-j~X99æ|Ë+"®)ÃÃ8Â=Uÿ;f | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
397c71532ea2-26 | '7bÃâ#]['ûÃãç*&LQNºâ¦Ã®KÃ!ì¬ÃŽÂùÃ)ÃÃz¹"KÃöâºÃ
Change Log
Version
Change
v10
Added /<module>/enum/: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/moduletempfilefieldtemp_id_GET/index.html |
db4bcc6950d8-0 | /Teams/:record/link/:link_name/:remote_id POST
Overview
Creates a relationship to a pre-existing record.
Query String Parameters
This endpoint does not accept any arguments.
Response Arguments
Name
Type
Description
record
Array
The record linked to the related record.
related_record
Array
The record that was associated.
Response
{
"record":{
"id":"da6a3741-2a81-ba7f-f249-512d0932e94e",
"name":"Slender Broadband Inc - 1000 units",
"date_entered":"2013-02-26T19:12:00+00:00", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_POST/index.html |
db4bcc6950d8-1 | "date_modified":"2013-02-26T19:12:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"last_activity_date":"2013-02-28T18:21:00+00:00",
"deleted":false,
"assigned_user_id":"seed_max_id",
"assigned_user_name":"Max Jensen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_POST/index.html |
db4bcc6950d8-2 | },
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"opportunity_type":"",
"account_name":"Slender Broadband Inc",
"account_id":"181461c6-dc81-1115-1fe0-512d092e8f15",
"campaign_id":"",
"campaign_name":"",
"lead_source":"Campaign",
"amount":"25000",
"base_rate":"1",
"amount_usdollar":"25000",
"currency_id":"-99",
"currency_name":"",
"currency_symbol":"",
"date_closed":"2013-02-27", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_POST/index.html |
db4bcc6950d8-3 | "date_closed":"2013-02-27",
"date_closed_timestamp":"1361992480",
"next_step":"",
"sales_stage":"Needs Analysis",
"sales_status":"New",
"probability":"90",
"best_case":"25000",
"worst_case":"25000",
"commit_stage":"include",
"my_favorite":false,
"_acl":{
"fields":{
}
}
},
"related_record":{
"id":"e689173e-c953-1e14-c215-512d0927e7a2",
"name":"Gus Dales",
"date_entered":"2013-02-26T19:12:00+00:00", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_POST/index.html |
db4bcc6950d8-4 | "date_modified":"2013-02-26T19:12:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"deleted":false,
"assigned_user_id":"seed_sally_id",
"assigned_user_name":"Sally Bronsen",
"team_name":[
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Gus",
"last_name":"Dales", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_POST/index.html |
db4bcc6950d8-5 | "first_name":"Gus",
"last_name":"Dales",
"full_name":"Gus Dales",
"title":"Director Operations",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(661) 120-2292",
"email":[
{
"email_address":"[email protected]",
"opt_out":"1",
"invalid_email":"0",
"primary_address":"0"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_POST/index.html |
db4bcc6950d8-6 | "opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
}
],
"phone_mobile":"(294) 447-9707",
"phone_work":"(036) 840-3216",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"primary_address_street":"48920 San Carlos Ave",
"primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Persistance",
"primary_address_state":"CA", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_POST/index.html |
db4bcc6950d8-7 | "primary_address_state":"CA",
"primary_address_postalcode":"54556",
"primary_address_country":"USA",
"alt_address_street":"",
"alt_address_street_2":"",
"alt_address_street_3":"",
"alt_address_city":"",
"alt_address_state":"",
"alt_address_postalcode":"",
"alt_address_country":"",
"assistant":"",
"assistant_phone":"",
"picture":"",
"email_and_name1":"",
"lead_source":"Support Portal User Registration",
"account_name":"Arts & Crafts Inc", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_POST/index.html |
db4bcc6950d8-8 | "account_name":"Arts & Crafts Inc",
"account_id":"d43243c6-9b8e-2973-aee2-512d09bc34b4",
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"Technical Advisor",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"GusDales145",
"portal_active":true,
"portal_password":"$1$JxYr6tmM$b.O6.KF42jP46RadSwz0N0",
"portal_password1":"",
"portal_app":"",
"preferred_language":"en_us", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_POST/index.html |
db4bcc6950d8-9 | "preferred_language":"en_us",
"campaign_id":"",
"campaign_name":"",
"c_accept_status_fields":"",
"m_accept_status_fields":"",
"accept_status_id":"",
"accept_status_name":"",
"sync_contact":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
}
}
Change Log
Version
Change
v10
Added /<module>/:record/link/:link_name/:remote_id POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_POST/index.html |
bdec181e933c-0 | /EmbeddedFiles/: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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/EmbeddedFilesrecordfilefield_PUT/index.html |
bdec181e933c-1 | 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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/EmbeddedFilesrecordfilefield_PUT/index.html |
bdec181e933c-2 | 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 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, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/EmbeddedFilesrecordfilefield_PUT/index.html |
bdec181e933c-3 | "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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/EmbeddedFilesrecordfilefield_PUT/index.html |
bdec181e933c-4 | "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/EmbeddedFilesrecordfilefield_PUT/index.html |
28c7e8a09091-0 | /ForecastManagerWorksheets/:timeperiod_id GET
Returns a collection of ForecastManagerWorksheet models
Summary:
This end point is used to return the ManagerWorksheets for a user at a given timeperiod. If no timeperiod is provide it
will use the default timeperiod, likewise if no user is provided, it will default to the logged in user.
Url Parameters:
Param
Description
Optional
timeperiod_id
Show for a specific time period, defaults to the current time period if one is not passed
Optional
user_id
Show for a specific user, defaults to current user if not defined
Optional
Possible Errors
Error
Description
412 - Invalid Parameter
When the passed in timeperiod and/or user can not be found
403 - Not Authorized | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_id_GET/index.html |
28c7e8a09091-1 | 403 - Not Authorized
If you are not an administrator, but you are trying to view another managers forecast manager worksheet, you will receive a 403 Not Authorized Error
Url Example:
/rest/v10/ForecastManagerWorksheets/:timeperiod_id/:user_id
Output Example:
{
"next_offset":-1,
"records":[
{
"id":"401594f5-5b46-fb66-1627-55771fe8723e",
"name":"Sally Bronsen",
"date_modified":"2015-06-09T13:13:26-04:00",
"created_by":"1",
"quota":"1932.444445",
"best_case":"29848.000000", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_id_GET/index.html |
28c7e8a09091-2 | "best_case":"29848.000000",
"best_case_adjusted":"37310.000000",
"likely_case":"28694.444445",
"likely_case_adjusted":"35868.055556",
"worst_case":"27540.888889",
"worst_case_adjusted":"34426.111111",
"timeperiod_id":"adb78e81-3fbd-b4e0-287f-55771fd04a06",
"draft":true,
"is_manager":false,
"user_id":"seed_sally_id",
"opp_count":10,
"pipeline_opp_count":3,
"pipeline_amount":"2415.555556",
"closed_amount":"26278.888889", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_id_GET/index.html |
28c7e8a09091-3 | "closed_amount":"26278.888889",
"manager_saved":true,
"show_history_log":0,
"following":false,
"assigned_user_id":"seed_sarah_id",
"assigned_user_name":"Sarah Smith",
"team_name":[
{
"id":"1",
"name":"Global",
"name_2":"",
"primary":true
}
],
"currency_id":"-99",
"base_rate":"1.000000",
"_acl":{
"fields":{
}
},
"_module":"ForecastManagerWorksheets"
},
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_id_GET/index.html |
28c7e8a09091-4 | "_module":"ForecastManagerWorksheets"
},
{
"id":"28226f12-a3c9-bd84-041e-55771f064c4e",
"name":"Max Jensen",
"date_modified":"2015-06-09T13:13:26-04:00",
"created_by":"1",
"quota":"3141.333332",
"best_case":"15848.222223",
"best_case_adjusted":"13206.851853",
"likely_case":"14928.222222",
"likely_case_adjusted":"12440.185185",
"worst_case":"14008.222223",
"worst_case_adjusted":"11673.518519", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_id_GET/index.html |
28c7e8a09091-5 | "worst_case_adjusted":"11673.518519",
"timeperiod_id":"adb78e81-3fbd-b4e0-287f-55771fd04a06",
"draft":true,
"is_manager":false,
"user_id":"seed_max_id",
"opp_count":12,
"pipeline_opp_count":3,
"pipeline_amount":"2617.777777",
"closed_amount":"12310.444445",
"manager_saved":true,
"show_history_log":0,
"following":false,
"assigned_user_id":"seed_sarah_id",
"assigned_user_name":"Sarah Smith",
"team_name":[ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_id_GET/index.html |
28c7e8a09091-6 | "team_name":[
{
"id":"1",
"name":"Global",
"name_2":"",
"primary":true
}
],
"currency_id":"-99",
"base_rate":"1.000000",
"_acl":{
"fields":{
}
},
"_module":"ForecastManagerWorksheets"
},
{
"id":"1aca66af-f069-bba4-28a1-55771fe27506",
"name":"",
"date_modified":"2015-06-09T13:13:26-04:00",
"created_by":"1",
"quota":"10142.333333",
"best_case":"37625.000000", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_id_GET/index.html |
28c7e8a09091-7 | "best_case":"37625.000000",
"best_case_adjusted":"37625.000000",
"likely_case":"34241.333333",
"likely_case_adjusted":"34241.333333",
"worst_case":"30857.666667",
"worst_case_adjusted":"30857.666667",
"timeperiod_id":"adb78e81-3fbd-b4e0-287f-55771fd04a06",
"draft":true,
"is_manager":true,
"user_id":"seed_sarah_id",
"opp_count":13,
"pipeline_opp_count":6,
"pipeline_amount":"10142.333333",
"closed_amount":"24099.000000", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_id_GET/index.html |
28c7e8a09091-8 | "closed_amount":"24099.000000",
"manager_saved":true,
"show_history_log":0,
"following":false,
"assigned_user_id":"seed_sarah_id",
"assigned_user_name":"Sarah Smith",
"team_name":[
{
"id":"1",
"name":"Global",
"name_2":"",
"primary":true
}
],
"currency_id":"-99",
"base_rate":"1.000000",
"_acl":{
"fields":{
}
},
"_module":"ForecastManagerWorksheets"
}
]
}
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/ForecastManagerWorksheetstimeperiod_id_GET/index.html |
3628602a44aa-0 | /connector/twitter/currentUser GET
Overview
Responds with twitter timeline if connector is set up in administration
Request Arguments
Name
Type
Description
Required
count
Integer
The number of tweets to retrieve.
False
Response Arguments
Name
Type
Description
<response>
String
Response
[
{
"created_at":"Tue Jun 25 23:45:35 +0000 2013",
"id":349674766946414592,
"id_str":"349674766946414592",
"text":"this tweet is awesome!",
"source":"web",
"truncated":false,
"in_reply_to_status_id":null,
"in_reply_to_status_id_str":null, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectortwittercurrentUser_GET/index.html |
3628602a44aa-1 | "in_reply_to_status_id_str":null,
"in_reply_to_user_id":143456975,
"in_reply_to_user_id_str":"14934565",
"in_reply_to_screen_name":"testdesk",
"user":{
"id":2630841,
"id_str":"2630841",
"name":"SugarCRM",
"screen_name":"sugarcrm",
"location":"Cupertino, CA",
"description":"Everyone Sells. Everyone Supports. Everyone Connects.",
"url":"http:\/\/t.co\/s9ejrBSlki",
"entities":{
"url":{
"urls":[
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectortwittercurrentUser_GET/index.html |
3628602a44aa-2 | "url":{
"urls":[
{
"url":"http:\/\/t.co\/s9ejrBSlki",
"expanded_url":"http:\/\/www.sugarcrm.com",
"display_url":"sugarcrm.com",
"indices":[
0,
22
]
}
]
},
"description":{
"urls":[
]
}
},
"protected":false,
"followers_count":8761,
"friends_count":6966,
"listed_count":453,
"created_at":"Wed Mar 28 07:16:58 +0000 2007",
"favourites_count":27,
"utc_offset":-28800, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectortwittercurrentUser_GET/index.html |
3628602a44aa-3 | "utc_offset":-28800,
"time_zone":"Pacific Time (US \u0026 Canada)",
"geo_enabled":false,
"verified":false,
"statuses_count":7488,
"lang":"en",
"contributors_enabled":false,
"is_translator":false,
"profile_background_color":"98C7EA",
"profile_background_image_url":"http:\/\/a0.twimg.com\/profile_background_images\/551274192\/sugar-twitter-background.png",
"profile_background_image_url_https":"https:\/\/si0.twimg.com\/profile_background_images\/551274192\/sugar-twitter-background.png",
"profile_background_tile":false, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectortwittercurrentUser_GET/index.html |
3628602a44aa-4 | "profile_background_tile":false,
"profile_image_url":"http:\/\/a0.twimg.com\/profile_images\/2027721183\/Sugar_cube_RGB_180x180_normal.png",
"profile_image_url_https":"https:\/\/si0.twimg.com\/profile_images\/2027721183\/Sugar_cube_RGB_180x180_normal.png",
"profile_link_color":"0045AD",
"profile_sidebar_border_color":"FFFFFF",
"profile_sidebar_fill_color":"CCEAFF",
"profile_text_color":"000000",
"profile_use_background_image":true,
"default_profile":false,
"default_profile_image":false, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectortwittercurrentUser_GET/index.html |
3628602a44aa-5 | "default_profile":false,
"default_profile_image":false,
"following":null,
"follow_request_sent":false,
"notifications":null
},
"geo":null,
"coordinates":null,
"place":null,
"contributors":null,
"retweet_count":1,
"favorite_count":0,
"entities":{
"hashtags":[
],
"symbols":[
],
"urls":[
],
"user_mentions":[
{
"screen_name":"testdesk",
"name":"testdesk",
"id":143455,
"id_str":"ertrt75",
"indices":[
0,
8 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectortwittercurrentUser_GET/index.html |
3628602a44aa-6 | "indices":[
0,
8
]
}
],
"media":[
]
},
"favorited":false,
"retweeted":false,
"possibly_sensitive":false,
"lang":"en"
}
]
Change Log
Version
Change
v10
Added /twitter/{twitterId} 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/connectortwittercurrentUser_GET/index.html |
fedede4284bc-0 | /<module>/config PUT
Overview
Retrieves the config settings for a given module.
Summary
This endpoint is normally used to manage the forecasting module.
Request Arguments
Name
Type
Description
Required
<config field>
<config field type>
The list of config fields to update.
False
Request
{
"MyConfigOption":"MyConfigValue"
}
Response Arguments
Name
Type
Description
<config field>
<config field type>
The list of config fields will be returned.
Response
{
"MyConfigOption":"MyConfigValue"
}
Change Log
Version
Change
v10
Added /<module>/config PUT endpoint. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleconfig_PUT/index.html |
fedede4284bc-1 | Added /<module>/config 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/moduleconfig_PUT/index.html |
8a55b62b896b-0 | /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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/globalsearch_GET/index.html |
8a55b62b896b-1 | 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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/globalsearch_GET/index.html |
8a55b62b896b-2 | False
highlights
Boolean
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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/globalsearch_GET/index.html |
8a55b62b896b-3 | 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/globalsearch_GET/index.html |
dde9bf6b4610-0 | /<module>/:lhs_sync_key_field_value/link_by_sync_keys/:link_name/:rhs_sync_key_field_value DELETE
Overview
Removes a relationship based on sync_key. 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_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_value
String
A unique ID for the RHS record identifying it in an external system
True
Request | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulelhs_sync_key_field_valuelink_by_sync_keyslink_namerhs_sync_key_field_value_DELETE/index.html |
dde9bf6b4610-1 | A unique ID for the RHS record identifying it in an external system
True
Request
/<module>/:lhs_sync_key_field_value/link_by_sync_keys/:link_name/:rhs_sync_key_field_value
Response Arguments
Name
Type
Description
record
String
The ID of the record.
related_record
String
The ID of the related record.
Response
Status 200
{
"record": "a0328573-a252-a27c-3530-4e4297d4c9e1",
"related_record": "a0328573-bc54-a554-3530-4e4297d4c9e1"
}
Status 422
{
"error": "invalid_parameter", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulelhs_sync_key_field_valuelink_by_sync_keyslink_namerhs_sync_key_field_value_DELETE/index.html |
dde9bf6b4610-2 | }
Status 422
{
"error": "invalid_parameter",
"error_message": "Could not find record with :xhs_sync_key_field_value in module: <module>"
}
Change Log
Version
Change
v11_10
Added /<module>/:lhs_sync_key_field_value/link_by_sync_keys/:link_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/modulelhs_sync_key_field_valuelink_by_sync_keyslink_namerhs_sync_key_field_value_DELETE/index.html |
9846ee5538e8-0 | /<module>/:record/audit GET
Overview
Returns data changes for a specific record.
Request Arguments
Name
Type
Description
Required
record
String
The record id.
True
module
String
The name of the module.
True
Query Parameters
Name
Type
Description
Required
max_num
Integer
A maximum number of records to return. The default is all records.
False
offset
Integer
The number of records to skip over before records are returned. The default is 0. The parameter will be ignored if the max_num parameter is missing.
False
Response Arguments
Name
Type
Description
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more records.
records
Array
An array of results containing matched records.
Response
{
"next_offset":-1, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordaudit_GET/index.html |
9846ee5538e8-1 | Response
{
"next_offset":-1,
"records":[
{
"id":"b569e480-237a-5921-4382-512ff555fee7",
"parent_id":"ef1b40aa-5815-4f8d-e909-512d09617ac8",
"date_created":"03\/01\/2013 12:26am",
"created_by":"admin",
"field_name":"Team ID:",
"data_type":"team_list",
"before_value_string":"East",
"after_value_string":"Will"
},
{
"id":"bc0bee72-8398-a0a6-d731-512ff5bfebc7", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordaudit_GET/index.html |
9846ee5538e8-2 | "parent_id":"ef1b40aa-5815-4f8d-e909-512d09617ac8",
"date_created":"03\/01\/2013 12:26am",
"created_by":"admin",
"field_name":"Teams",
"data_type":"id",
"before_value_string":"East, Global, West",
"after_value_string":"Jim, Will"
}
]
}
Change Log
Version
Change
v11_11
Added optional max_num and offset parameters to /Audit GET endpoint.
v10
Added /Audit GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordaudit_GET/index.html |
384b9dfd2f2f-0 | /me/preference/:preference_name GET
Overview
Returns a specific preference for the current user.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
Â
Â
Â
Response
{
}
Change Log
Version
Change
v10
Added /me/preference/:preference_name 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/mepreferencepreference_name_GET/index.html |
f3cb724277aa-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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfilefield_DELETE/index.html |
f3cb724277aa-1 | 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 |
58e6eda5884d-0 | /Forecasts/config PUT
Creates and/or updates the config settings for the Forecasts module
Summary:
This endpoint is used to create and/or update the config settings for the Forecasts module as json data. It extends
the core config endpoint by adding the functionality to create
the Timeperiods and updates existing Opportunities for use in the Forecasts module.
Query Parameters:
Param
Description
Optional
Input Example:
{
"is_setup": 1,
"is_upgrade": 0,
"has_commits": 1,
"timeperiod_type": "chronological",
"timeperiod_interval": "Annual",
"timeperiod_leaf_interval": "Quarter",
"timeperiod_start_date": "2013-01-01",
"timeperiod_shown_forward": 2, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsconfig_PUT/index.html |
58e6eda5884d-1 | "timeperiod_shown_forward": 2,
"timeperiod_shown_backward": 2,
"forecast_ranges": "show_binary",
"buckets_dom": "commit_stage_binary_dom",
"show_binary_ranges": {
"include": {
"min": 70,
"max": 100
},
"exclude": {
"min": 0,
"max": 69
}
},
"show_buckets_ranges": {
"include": {
"min": 85,
"max": 100
},
"upside": {
"min": 70,
"max": 84
},
"exclude": {
"min": 0,
"max": 69
}
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsconfig_PUT/index.html |
58e6eda5884d-2 | "min": 0,
"max": 69
}
},
"sales_stage_won": [
"Closed Won"
],
"sales_stage_lost": [
"Closed Lost"
],
"show_worksheet_likely": 1,
"show_worksheet_best": 1,
"show_worksheet_worst": 0,
"show_projected_likely": 1,
"show_projected_best": 1,
"show_projected_worst": 0,
"show_forecasts_commit_warnings": 1
}
Output Example:
{
"is_setup": 1,
"is_upgrade": 0,
"has_commits": 1,
"timeperiod_type": "chronological", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsconfig_PUT/index.html |
58e6eda5884d-3 | "timeperiod_type": "chronological",
"timeperiod_interval": "Annual",
"timeperiod_leaf_interval": "Quarter",
"timeperiod_start_date": "2013-01-01",
"timeperiod_shown_forward": 2,
"timeperiod_shown_backward": 2,
"forecast_ranges": "show_binary",
"buckets_dom": "commit_stage_binary_dom",
"show_binary_ranges": {
"include": {
"min": 70,
"max": 100
},
"exclude": {
"min": 0,
"max": 69
}
},
"show_buckets_ranges": {
"include": {
"min": 85, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsconfig_PUT/index.html |
58e6eda5884d-4 | "include": {
"min": 85,
"max": 100
},
"upside": {
"min": 70,
"max": 84
},
"exclude": {
"min": 0,
"max": 69
}
},
"sales_stage_won": [
"Closed Won"
],
"sales_stage_lost": [
"Closed Lost"
],
"show_worksheet_likely": 1,
"show_worksheet_best": 1,
"show_worksheet_worst": 0,
"show_projected_likely": 1,
"show_projected_best": 1,
"show_projected_worst": 0,
"show_forecasts_commit_warnings": 1 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsconfig_PUT/index.html |
58e6eda5884d-5 | "show_forecasts_commit_warnings": 1
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsconfig_PUT/index.html |
3467ec2b2708-0 | /pmse_Emails_Templates/:record/etemplate GET
Overview
Exports a .pet file with a Process Email Templates definition
Summary
This endpoint will retrieve a .pet file containing JSON encoded data of a
Process Email Templates definition identified by the record input
parameter.
Request Arguments
Name
Type
Description
Required
record
String
The Process Email Template record ID
True
Response Arguments
Name
Type
Description
N/A
Response
Note: The response is a MIME type application/pet 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_Emails_Templatesrecordetemplate_GET/index.html |
d1a380fca08d-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 |
7a316b79a1c3-0 | /ForecastWorksheets GET
Returns a collection of ForecastWorksheet models
Summary:
This end point is used to return the Worksheets for a user at a given timeperiod. If no timeperiod is provide it
will use the default timeperiod, likewise if no user is provided, it will default to the logged in user.
Also this end points use the visibility requirements set forth by the application, that if the records being requested
belong to you, you will get the draft version, If the worksheet is not yours, you will only see the committed version.
Url Parameters:
Param
Description
Optional
timeperiod_id
Show for a specific time period, defaults to the current time period if one is not passed
Optional
user_id
Show for a specific user, defaults to current user if not defined
Optional
Query Parameters:
Param
Description
Optional
type | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheets_GET/index.html |
7a316b79a1c3-1 | Optional
Query Parameters:
Param
Description
Optional
type
Which type to return, currently the ones that are supported are, opportunity and product
Optional
Possible Errors
Error
Description
412 - Invalid Parameter
When the passed in timeperiod and/or user can not be found
403 - Not Authorized
If you are not a manager, but you are tyring to view another sales rep forecast worksheet, you will receive a 403 Not Authorized Error
Url Example:
/rest/v10/ForecastWorksheets/:timeperiod_id/:user_id
Output Example:
{ "next_offset": -1,
"records": [
{
"id": "ad3908c7-83a3-f360-c223-51117844c208",
"name": "Grow-Fast Inc - 1000 units", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheets_GET/index.html |
7a316b79a1c3-2 | "name": "Grow-Fast Inc - 1000 units",
"date_entered": "2013-02-05T21:22:00+00:00",
"date_modified": "2013-02-05T21:22:00+00:00",
"modified_user_id": "1",
"modified_by_name": "Administrator",
"created_by": "1",
"created_by_name": "Administrator",
"description": "",
"img": "",
"deleted": "0",
"assigned_user_id": "seed_jim_id",
"assigned_user_name": "Jim Brennan",
"team_name": [
{
"id": "East",
"name": "East", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheets_GET/index.html |
7a316b79a1c3-3 | {
"id": "East",
"name": "East",
"name_2": "",
"primary": true
}
],
"parent_id": "50b90565-e748-ed77-d9d7-511178f5acae",
"parent_type": "Opportunities",
"account_name": "",
"account_id": "",
"likely_case": "75000",
"best_case": "75000",
"worst_case": "75000",
"base_rate": "1",
"currency_id": "-99",
"currency_name": "",
"currency_symbol": "",
"date_closed": "2013-02-10", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheets_GET/index.html |
7a316b79a1c3-4 | "date_closed": "2013-02-10",
"date_closed_timestamp": "1360531443",
"sales_stage": "Perception Analysis",
"probability": "70",
"commit_stage": "include",
"draft": "1",
"my_favorite": false,
"_acl": {
"fields": {}
}
}]
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheets_GET/index.html |
d695af86118b-0 | /Administration/packages/staged GET
Overview
[ADMIN] PackageManager lists staged packages.
Summary
Lists staged packages in the system.
Response
{
"packages": [
{
"name": "project_P1",
"version": 1580885419,
"published_date": "2020-02-05 06:50:19",
"description": "None",
"uninstallable": "Yes",
"type": "Module",
"file": "0ef4dd8b237f4358bdb246a744eb2b38",
"file_install": "5d4b4614421586fd2111714abf622392",
"unFile": "5d4b4614421586fd2111714abf622392"
}
] | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationpackagesstaged_GET/index.html |
d695af86118b-1 | }
]
}
Change Log
Version
Change
v11.8
Added /Administration/packages/staged 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/Administrationpackagesstaged_GET/index.html |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.