"name_2": "",
            "primary": true,
            "selected": false
        }],
        "currency_id": "-99",
        "base_rate": "1.000000",
        "currency_name": "",
        "currencies": {
            "name": "",
            "id": "-99",
            "_acl": {
                "fields": [],
                "_hash": "654d337e0e912edaa00dbb0fb3dc3c17"
            },
            "symbol": ""
        },
        "currency_symbol": "",
        "_acl": {
            "fields": {}
        },
        "_module": "Quotes"
    }
}
  	Last modified: 2023-02-03 21:04:03


/KBContents/config POST
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


/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"
        }
    ]
}
Change Log
Version
Change
v11.8
Added /Administration/packages/stagedÂ GET endpoint.
  	Last modified: 2023-02-03 21:04:03


/ping/whattimeisit GET
Overview
    Responds with the current time in server format.
Request Arguments
    This endpoint does not accept any arguments.
Response Arguments
Name
Type
Description
            <server time>

            String

            Returns the servers time.

Response
<time>
Change Log
Version
Change
            v10

            Added /ping/whattimeisit GET endpoint.

  	Last modified: 2023-02-03 21:04:03


/<module>/sync_key/:sync_key_field_value PUT
Overview
Upserts based on sync_key. If a record can be found with sync_key, 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 for an existing Sugar record. To do so, it is recommended to use the set sync key endpoint to update the matching Sugar record ID. Once the sync_key is set for the record, then it is possible to leverage this endpoint.
Request Arguments
Name
Type
Description
Required
module
String
The module the record belongs to
True
sync_key_field_value
String
A unique ID for the record identifying it in an external system
True
Request
/<module>/sync_key/:sync_key_field_value
Response Arguments
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 /<module>/sync_key/:sync_key_field_valueÂ PUT endpoint.
  	Last modified: 2023-02-03 21:04:03


/<module>/favorites GET
Overview
    Opportunity Favorites Help
Summary
    This endpoint returns all the favorite Quotes/Revenue Line Items in alphabetical order to be displayed in the
    "Product Catalog Quick Picks" dashlet.
Request Arguments
Name
Type
Description
Required
            pageNum

            integer

            An integer attribute in the payload data object which gets the page number for which the items need to be
            displayed based on the current page or the page clicked.

            False

Request
{
    pageNum: 0
}
Response Arguments
Name
Type
Description
            <config field>

            <config field type>

            The list of config fields will be returned.

Response
{
    "totalPages":5,
    "pageNum":0,
    "max_num":8,
    "records":[
                {
                    "id":"c181bd32-c7f2-11e8-b4eb-7831c1c14620",
                    "name":"Allyson Gadget",
                    "date_entered":"2018-10-04 16:28:37",
                    "date_modified":"2018-10-04 16:28:37",
                    "modified_user_id":"1",
                    "created_by":"1",
                    "description":null,
                    "deleted":0,
                    "type_id":null,
                    "manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
                    "category_id":"c18112d8-c7f2-11e8-b753-7831c1c14620",
                    "mft_part_num":"Ink Conglomerate Inc 921535XYZ987",


"vendor_part_num":null,
                    "date_cost_price":null,
                    "cost_price":"534.000000",
                    "discount_price":"842.000000",
                    "list_price":"905.000000",
                    "cost_usdollar":"534.000000",
                    "discount_usdollar":"842.000000",
                    "list_usdollar":"905.000000",
                    "status":"Available",
                    "tax_class":"Taxable",
                    "date_available":"2004-10-15",
                    "website":null,
                    "weight":"20.00",
                    "qty_in_stock":26,
                    "support_name":null,
                    "support_description":null,
                    "support_contact":null,
                    "support_term":null,
                    "pricing_formula":"Fixed",
                    "pricing_factor":"1.00",
                    "assigned_user_id":null,
                    "currency_id":"-99",
                    "base_rate":"1.000000"
                },
                {
                    "id":"c18e0448-c7f2-11e8-86b0-7831c1c14620",
                    "name":"Arla Gadget",
                    "date_entered":"2018-10-04 16:28:37",
                    "date_modified":"2018-10-04 16:28:37",
                    "modified_user_id":"1",
                    "created_by":"1",
                    "description":null,
                    "deleted":0,
                    "type_id":null,
                    "manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",


"category_id":"c18b8b64-c7f2-11e8-8c1a-7831c1c14620",
                    "mft_part_num":"24\/7 Couriers 795391XYZ987",
                    "vendor_part_num":null,
                    "date_cost_price":null,
                    "cost_price":"398.000000",
                    "discount_price":"402.020202",
                    "list_price":"941.000000",
                    "cost_usdollar":"398.000000",
                    "discount_usdollar":"402.020202",
                    "list_usdollar":"941.000000",
                    "status":"Available",
                    "tax_class":"Taxable",
                    "date_available":"2004-10-15",
                    "website":null,
                    "weight":"22.00",
                    "qty_in_stock":145,
                    "support_name":null,
                    "support_description":null,
                    "support_contact":null,
                    "support_term":null,
                    "pricing_formula":"ProfitMargin",
                    "pricing_factor":"1.00",
                    "assigned_user_id":null,
                    "currency_id":"-99",
                    "base_rate":"1.000000"
                },
                {
                    "id":"c1b60434-c7f2-11e8-8964-7831c1c14620",
                    "name":"Billie Gadget",
                    "date_entered":"2018-10-04 16:28:37",
                    "date_modified":"2018-10-04 16:28:37",
                    "modified_user_id":"1",
                    "created_by":"1",
                    "description":null,
                    "deleted":0,


"description":null,
                    "deleted":0,
                    "type_id":null,
                    "manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
                    "category_id":"c1b3bf58-c7f2-11e8-92e7-7831c1c14620",
                    "mft_part_num":"Kringle Bell IncK.A. Tower \u0026 Co 694143XYZ987",
                    "vendor_part_num":null,
                    "date_cost_price":null,
                    "cost_price":"403.000000",
                    "discount_price":"927.000000",
                    "list_price":"927.000000",
                    "cost_usdollar":"403.000000",
                    "discount_usdollar":"927.000000",
                    "list_usdollar":"927.000000",
                    "status":"Available",
                    "tax_class":"Taxable",
                    "date_available":"2004-10-15",
                    "website":null,
                    "weight":"16.00",
                    "qty_in_stock":148,
                    "support_name":null,
                    "support_description":null,
                    "support_contact":null,
                    "support_term":null,
                    "pricing_formula":"IsList",
                    "pricing_factor":"1.00",
                    "assigned_user_id":null,
                    "currency_id":"-99",
                    "base_rate":"1.000000"
                },
                {
                    "id":"c186a612-c7f2-11e8-9fee-7831c1c14620",
                    "name":"Bradford Gadget",


"name":"Bradford Gadget",
                    "date_entered":"2018-10-04 16:28:37",
                    "date_modified":"2018-10-04 16:28:37",
                    "modified_user_id":"1",
                    "created_by":"1",
                    "description":null,
                    "deleted":0,
                    "type_id":null,
                    "manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
                    "category_id":"c185dbb0-c7f2-11e8-a6b7-7831c1c14620",
                    "mft_part_num":"Mississippi Bank Group 133834XYZ987",
                    "vendor_part_num":null,
                    "date_cost_price":null,
                    "cost_price":"528.000000",
                    "discount_price":"533.333333",
                    "list_price":"745.000000",
                    "cost_usdollar":"528.000000",
                    "discount_usdollar":"533.333333",
                    "list_usdollar":"745.000000",
                    "status":"Available",
                    "tax_class":"Taxable",
                    "date_available":"2004-10-15",
                    "website":null,
                    "weight":"33.00",
                    "qty_in_stock":70,
                    "support_name":null,
                    "support_description":null,
                    "support_contact":null,
                    "support_term":null,
                    "pricing_formula":"ProfitMargin",
                    "pricing_factor":"1.00",
                    "assigned_user_id":null,
                    "currency_id":"-99",
                    "base_rate":"1.000000"
                },
                {


"base_rate":"1.000000"
                },
                {
                    "id":"c1b4680e-c7f2-11e8-9380-7831c1c14620",
                    "name":"Brain Gadget",
                    "date_entered":"2018-10-04 16:28:37",
                    "date_modified":"2018-10-04 16:28:37",
                    "modified_user_id":"1",
                    "created_by":"1",
                    "description":null,
                    "deleted":0,
                    "type_id":null,
                    "manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
                    "category_id":"c1b3bf58-c7f2-11e8-92e7-7831c1c14620",
                    "mft_part_num":"Smallville Resources Inc 362299XYZ987",
                    "vendor_part_num":null,
                    "date_cost_price":null,
                    "cost_price":"370.000000",
                    "discount_price":"854.370000",
                    "list_price":"863.000000",
                    "cost_usdollar":"370.000000",
                    "discount_usdollar":"854.370000",
                    "list_usdollar":"863.000000",
                    "status":"Available",
                    "tax_class":"Taxable",
                    "date_available":"2004-10-15",
                    "website":null,
                    "weight":"10.00",
                    "qty_in_stock":106,
                    "support_name":null,
                    "support_description":null,
                    "support_contact":null,
                    "support_term":null,


"support_contact":null,
                    "support_term":null,
                    "pricing_formula":"PercentageDiscount",
                    "pricing_factor":"1.00",
                    "assigned_user_id":null,
                    "currency_id":"-99",
                    "base_rate":"1.000000"
                },
                {
                    "id":"c1baf0e8-c7f2-11e8-ab05-7831c1c14620",
                    "name":"Carley Gadget",
                    "date_entered":"2018-10-04 16:28:37",
                    "date_modified":"2018-10-04 16:28:37",
                    "modified_user_id":"1",
                    "created_by":"1",
                    "description":null,
                    "deleted":0,
                    "type_id":null,
                    "manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
                    "category_id":"c1b8e4ec-c7f2-11e8-b435-7831c1c14620",
                    "mft_part_num":"Hollywood Diner Ltd 10023XYZ987",
                    "vendor_part_num":null,
                    "date_cost_price":null,
                    "cost_price":"554.000000",
                    "discount_price":"559.595960",
                    "list_price":"927.000000",
                    "cost_usdollar":"554.000000",
                    "discount_usdollar":"559.595959",
                    "list_usdollar":"927.000000",
                    "status":"Available",
                    "tax_class":"Taxable",
                    "date_available":"2004-10-15",
                    "website":null,


"date_available":"2004-10-15",
                    "website":null,
                    "weight":"30.00",
                    "qty_in_stock":58,
                    "support_name":null,
                    "support_description":null,
                    "support_contact":null,
                    "support_term":null,
                    "pricing_formula":"ProfitMargin",
                    "pricing_factor":"1.00",
                    "assigned_user_id":null,
                    "currency_id":"-99",
                    "base_rate":"1.000000"
                },
                {
                    "id":"c1b77544-c7f2-11e8-8347-7831c1c14620",
                    "name":"Carma Gadget",
                    "date_entered":"2018-10-04 16:28:37",
                    "date_modified":"2018-10-04 16:28:37",
                    "modified_user_id":"1",
                    "created_by":"1",
                    "description":null,
                    "deleted":0,
                    "type_id":null,
                    "manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
                    "category_id":"c1b3bf58-c7f2-11e8-92e7-7831c1c14620",
                    "mft_part_num":"Sea Region Inc 773472XYZ987",
                    "vendor_part_num":null,
                    "date_cost_price":null,
                    "cost_price":"332.000000",
                    "discount_price":"745.000000",
                    "list_price":"822.000000",
                    "cost_usdollar":"332.000000",
                    "discount_usdollar":"745.000000",


"discount_usdollar":"745.000000",
                    "list_usdollar":"822.000000",
                    "status":"Available",
                    "tax_class":"Taxable",
                    "date_available":"2004-10-15",
                    "website":null,
                    "weight":"35.00",
                    "qty_in_stock":1,
                    "support_name":null,
                    "support_description":null,
                    "support_contact":null,
                    "support_term":null,
                    "pricing_formula":"Fixed",
                    "pricing_factor":"1.00",
                    "assigned_user_id":null,
                    "currency_id":"-99",
                    "base_rate":"1.000000"
                },
                {
                    "id":"c1b98c9e-c7f2-11e8-9740-7831c1c14620",
                    "name":"Catrina Gadget",
                    "date_entered":"2018-10-04 16:28:37",
                    "date_modified":"2018-10-04 16:28:37",
                    "modified_user_id":"1",
                    "created_by":"1",
                    "description":null,
                    "deleted":0,
                    "type_id":null,
                    "manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
                    "category_id":"c1b8e4ec-c7f2-11e8-b435-7831c1c14620",
                    "mft_part_num":"Jungle Systems Inc 273034XYZ987",
                    "vendor_part_num":null,
                    "date_cost_price":null,
                    "cost_price":"577.000000",


"date_cost_price":null,
                    "cost_price":"577.000000",
                    "discount_price":"582.770000",
                    "list_price":"946.000000",
                    "cost_usdollar":"577.000000",
                    "discount_usdollar":"582.770000",
                    "list_usdollar":"946.000000",
                    "status":"Available",
                    "tax_class":"Taxable",
                    "date_available":"2004-10-15",
                    "website":null,
                    "weight":"13.00",
                    "qty_in_stock":105,
                    "support_name":null,
                    "support_description":null,
                    "support_contact":null,
                    "support_term":null,
                    "pricing_formula":"PercentageMarkup",
                    "pricing_factor":"1.00",
                    "assigned_user_id":null,
                    "currency_id":"-99",
                    "base_rate":"1.000000"
                }
            ]
}
Change Log
Version
Change
            v10

            Added /Opportunities/favorites GET endpoint.

  	Last modified: 2023-02-03 21:04:03


/Genericsearch POST
Overview
Generic search.
Summary
This endpoint searches the content of the given modules using the provider specified by the "generic_search" configuration variable. If the variable is absent, the default provider is "Elastic".
Request Arguments
Name
Type
Description
Required
q
String
The search expression.
True
module_list
String
Comma-delimited list of modules to search. If omitted, all search enabled modules will be queried. Example: KBDocuments,Bugs
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
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.
total
Integer
The number of records found.
records
Array
An array of results containing matched records.
Response
{
    "next_offset": -1,
    "total": 1,
    "records": [
        {
            "name": "Connecting to the Internet",
            "description": "To connect your device to the Internet, use any application that accesses the Internet. You can connect using either Wi-Fi or Bluetooth.",
            "url": "portal/index.html#KBContents/60142236-bad3-11e9-9d32-3c15c2d57622" (for portal)
            "url": "#KBContents/60142236-bad3-11e9-9d32-3c15c2d57622" (for base)
        }
    ]
}
Change Log
Version
Change
v11_9
Added /GenericsearchÂ POST endpoint.


Version
Change
v11_9
Added /GenericsearchÂ POST endpoint.
  	Last modified: 2023-02-03 21:04:03


/PdfManager/generate GET
Overview
    PdfManager Generate Endpoint Help
Summary
    This endpoint returns and initiates download of a PDF.
Request Arguments
Name
Type
Description
Required
module
String
The Module name of the Bean from which to create a PDF
True
record
String
The Record ID from which to create a PDF
True
pdf_template_id
String
The PDF Template ID to use to create the PDF
True
sugarpdf
String
The type of PDF to use. Defaults to 'pdfmanager'.
False
Request
{
   "module": "Quotes",
   "record": "abcde-fghij-12345-67890",
   "pdf_template_id": "12345-67890-abcde-fghij",
   "sugarpdf": "pdfmanager"
}
Response
    The response is a base64 encoded string of the contents of the PDF file.
Change Log
Version
Change
v11.3
Added /PdfManager/generate GET endpoint.
  	Last modified: 2023-02-03 21:04:03


/Dashboards/Activities GET
Overview
    List current user's filtered Activity Stream dashboards.
Summary
    This endpoint will return a set of Activity Stream dashboards 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.
Notice
The behavior of this endpoint has changed 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 GET /<module>.

    Recommended Replacement:
GET /Dashboards
    The module name is no longer part of the path. To specify a module name, include it as a filter
    parameter, usev11:
GET /Dashboards?filter[0][dashboard_module]=Activities
    name, id. etc. are no longer specified as default fields. To retain the default fields, usev11:
        GET /Dashboards?filter[0][dashboard_module]=Activities&fields=id,name,view_name

Request Arguments
Name
Type
Description
Required
filter
String
See Filter API.
False
filter_id
String
            Identifier for a preexisting filter. See
            the Filter API for details.

False
max_num
Integer
            Max number of records that can be returned. Default is 20, unless overruled by your Sugar configuration.

False
offset
Integer


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.
            For more details on additional field parameters, see
            Relate API and
            Collection API.

False
order_by
String
See Filter API.
False
deleted
Boolean
Boolean to show deleted records in the result set.
False
Response Arguments
Name
Type
Description
next_offset
Integer
            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more
            records.

records
Array
An array of results containing matched records.
Response
{
  "next_offset": -1,
  "records": [
    {
      "id": "d509b3da-29f6-7b23-7cce-56fab1a6335b",
      "name": "Activity Stream Dashboard",
      "date_modified": "2016-03-29T09:46:00-07:00",
      "view_name": "activities",
      "_acl": {
        "fields": {}
      },
      "view": "activities",
      "_module": "Dashboards"
    },
    {
      "id": "cc4982cd-0bdf-bad4-d079-56fab4bdddf1",
      "name": "Activity Stream Dashboard 2",
      "date_modified": "2016-03-29T09:57:58-07:00",


"view_name": "activities",
      "_acl": {
        "fields": {}
      },
      "view": "activities",
      "_module": "Dashboards"
    }
  ]
}
Change Log
Version
Change
v11
No longer supported. Please use GET /Dashboards instead.
v10
Added /Dashboards/Activities GET endpoint.
  	Last modified: 2023-02-03 21:04:03


/Dashboards POST
    Create a new Home dashboard.
Notice
The behavior of this endpoint has changed in v11. For a description of behavior in v11, refer to
    POST /<module>. 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:
    Recommended Replacement: POST /Dashboards
    The Home module is no longer the default dashboard_module. To specify the Home
    module, include it in the Request Body.v11: POST /Dashboards with the following in the Request Body:
{"dashboard_module":"Home"}
Request Arguments
Name
Type
Description
Required
<record field>
<record field type>
The name value list of fields to populate.
True
Request
{
    "name": "New Home Dashboard",
    "dashboard_module": "Home",
    "view_name": "",
    "metadata": {
        "components": [{
            "rows": [[{
                "width": 12,
                "view": {
                    "limit": 10,
                    "visibility": "user",
                    "label": "Active Tasks",
                    "type": "active-tasks",
                    "module": null,
                    "template": "tabbed-dashlet"
                }
            }]],
            "width": 12
        }]
    }
}
Response Arguments
Name
Type
Description
<record field>
<record field type>
Returns the fields for the newly created dashboard.
Response
{
  "id": "4ccda6fa-fa02-9c8e-215f-56cf72f98fcb",
  "name": "New Home Dashboard",


"name": "New Home Dashboard",
  "date_entered": "2016-02-25T13:30:51-08:00",
  "date_modified": "2016-02-25T13:30:51-08:00",
  "modified_user_id": "1",
  "modified_by_name": "Administrator",
  "created_by": "1",
  "created_by_name": "Administrator",
  "description": "",
  "deleted": false,
  "dashboard_module": "Home",
  "view_name": "",
  "metadata": {
    "components": [
      {
        "rows": [
          [
            {
              "width": 12,
              "view": {
                "limit": 10,
                "visibility": "user",
                "label": "Active Tasks",
                "type": "active-tasks",
                "module": null,
                "template": "tabbed-dashlet"
              }
            }
          ]
        ],
        "width": 12
      }
    ]
  },
  "following": "",
  "my_favorite": false,
  "tag": [],
  "assigned_user_id": "1",
  "assigned_user_name": "Administrator",
  "_acl": {
    "fields": {}
  },
  "view": "",
  "_module": "Dashboards"
}
Change Log
Version
Change
v11
            Behavior has changed. Please see POST /Dashboards
            for the designated replacement.

v10
Added /Dashboards POST endpoint.
  	Last modified: 2023-02-03 21:04:03


/Administration/packages/:id/disable GET
Overview
[ADMIN] PackageManager disable a package.
Summary
Disable the specified package. Package id hash must be provided. Package id could be found in installed package list.
Response
Returns http status 200 OK and disabled package ID if request is successful.
{
"id": "56365210-4cce-11ea-a7bf-acde48001122"
}
Otherwise returns http status 4xx with errors.
{
"error": "not_found",
"error_message": "Could not find package by ID."
}
Change Log
Version
Change
v11.8
Added /Administration/packages/:id/disableÂ GET endpoint.
  	Last modified: 2023-02-03 21:04:03


/Leads/:leadId/convert POST
Convert Lead to a Contact and optionally link it to a new or existing instance of the modules specified
Summary:
    This endpoint is used to convert the specified Lead to a Contact and optionally link that Contact to a new or existing instance of the modules specified.
    The types of modules that can be specified are limited to those that have been configured by the system administrator.
Post Parameters:
Parameter
Description
modules (required)
An object containing the Contacts module to be created as part of the conversion, along with (optionally)
                any modules that this new Contact record is to be related to. If relate-to modules are also specified, they must
                consist of a valid module type and either the id of a existing module of that type, or if new, the full record
                to be created for that type.  Note that the allowed module types are defined by the System Administrator.

Â Example
    {
        "modules": {
            "Contacts": {
                "deleted": "0",
                "do_not_call": false,
                "portal_active": "0",
                "preferred_language": "en_us",
                "assigned_user_id": "1",
                "assigned_user_name": "Administrator",
                "salutation": "",
                "first_name": "Darius",
                "last_name": "Paisley",
                "title": "Director Operations",
                "department": "",
                "description": "",
                "team_name": [
                    {
                        "id": "East",
                        "name": "East",
                        "name_2": "",
                        "primary": true
                    },
                    {
                        "id": 1,
                        "name": "Global",
                        "name_2": "",
                        "primary": false


"name_2": "",
                        "primary": false
                    },
                    {
                        "id": "West",
                        "name": "West",
                        "name_2": "",
                        "primary": false
                    }
                ],
                "phone_home": "(890) 241-5509",
                "phone_mobile": "(738) 338-2546",
                "phone_work": "(579) 448-8879",
                "phone_fax": "",
                "primary_address_street": "123 Anywhere Street",
                "primary_address_city": "Salt Lake City",
                "primary_address_state": "CA",
                "primary_address_postalcode": "81738",
                "primary_address_country": "USA",
                "campaign_id": "",
                "campaign_name": "",
                "email": [
                    {
                        "email_address": "kid75@example.it",
                        "invalid_email": false,
                        "opt_out": false,
                        "primary_address": true,
                        "reply_to_address": false
                    }
                ]
            },
            "Accounts": {
                "id": "1c212ff9-c0d5-866d-d3ae-526e6cd47a31",
                "name": "Lexington Shores Corp",
                "date_entered": "2013-10-28T09:52:46-04:00",
                "date_modified": "2013-10-28T09:52:46-04:00",
                "modified_user_id": "1",
                "modified_by_name": "Administrator",
                "created_by": "1",
                "created_by_name": "Administrator",
                "description": "",
                "deleted": false,


"description": "",
                "deleted": false,
                "assigned_user_id": "seed_sally_id",
                "assigned_user_name": "Sally Bronsen",
                "team_count": "",
                "team_name": [
                    {
                        "id": "West",
                        "name": "West",
                        "name_2": "",
                        "primary": true
                    }
                ],
                "linkedin": "",
                "facebook": "",
                "twitter": "",
                "googleplus": "",
                "account_type": "Customer",
                "industry": "Electronics",
                "annual_revenue": "",
                "phone_fax": "",
                "billing_address_street": "111 Silicon Valley Road",
                "billing_address_street_2": "",
                "billing_address_street_3": "",
                "billing_address_street_4": "",
                "billing_address_city": "Santa Fe",
                "billing_address_state": "CA",
                "billing_address_postalcode": "63785",
                "billing_address_country": "USA",
                "rating": "",
                "phone_office": "(641) 347-6902",
                "phone_alternate": "",
                "website": "www.imphone.de",
                "ownership": "",
                "employees": "",
                "ticker_symbol": "",
                "shipping_address_street": "111 Silicon Valley Road",
                "shipping_address_street_2": "",
                "shipping_address_street_3": "",
                "shipping_address_street_4": "",
                "shipping_address_city": "Santa Fe",
                "shipping_address_state": "CA",
                "shipping_address_postalcode": "63785",
                "shipping_address_country": "USA",
                "email": [
                    {


"shipping_address_country": "USA",
                "email": [
                    {
                        "email_address": "section.qa@example.tw",
                        "invalid_email": false,
                        "opt_out": false,
                        "primary_address": true,
                        "reply_to_address": false
                    },
                    {
                        "email_address": "vegan29@example.de",
                        "invalid_email": false,
                        "opt_out": false,
                        "primary_address": false,
                        "reply_to_address": false
                    }
                ],
                "email1": "section.qa@example.tw",
                "parent_id": "",
                "sic_code": "",
                "parent_name": "",
                "email_opt_out": false,
                "invalid_email": false,
                "campaign_id": "",
                "campaign_name": "",
                "my_favorite": false,
                "_acl": {
                    "fields": {}
                },
                "following": false,
                "_module": "Accounts",
                "duplicate_check_rank": 8
            },
            "Opportunities": {
                "id": "5529e246-c42f-04e0-1989-526e6d3029c6",
                "name": "Lexington Shores Corp - 311 Units",
                "date_entered": "2013-10-28T09:52:46-04:00",
                "date_modified": "2013-10-28T09:52:46-04:00",
                "modified_user_id": "1",
                "modified_by_name": "Administrator",
                "created_by": "1",
                "created_by_name": "Administrator",
                "description": "",
                "deleted": false,


"description": "",
                "deleted": false,
                "assigned_user_id": "seed_sally_id",
                "assigned_user_name": "Sally Bronsen",
                "team_count": "",
                "team_name": [
                    {
                        "id": "West",
                        "name": "West",
                        "name_2": "",
                        "primary": true
                    }
                ],
                "opportunity_type": "",
                "account_name": "Lexington Shores Corp",
                "account_id": "1c212ff9-c0d5-866d-d3ae-526e6cd47a31",
                "campaign_id": "",
                "campaign_name": "",
                "lead_source": "Partner",
                "amount": 10413,
                "base_rate": 1,
                "amount_usdollar": 10413,
                "currency_id": "-99",
                "currency_name": "",
                "currency_symbol": "",
                "date_closed": "2014-03-30",
                "date_closed_timestamp": 1396187804,
                "next_step": "",
                "sales_stage": "Prospecting",
                "sales_status": "New",
                "probability": 10,
                "best_case": 11795,
                "worst_case": 9031,
                "commit_stage": "exclude",
                "total_revenue_line_items": 5,
                "closed_revenue_line_items": 1,
                "contact_role": "",
                "my_favorite": false,
                "_acl": {
                    "fields": {}
                },
                "following": false,
                "_module": "Opportunities",
                "duplicate_check_rank": 0
            }
        }
    }


"duplicate_check_rank": 0
            }
        }
    }

  	Last modified: 2023-02-03 21:04:03


/css GET
Overview
    Runs LessPHP for a platform and a theme and outputs an array of css files. If not found the css files
    will be compiled.
Request Arguments
Name
Type
Description
Required
platform
String
The theme platform - /themes/clients/***PLATFORM***/themeName/. Accepted values are 'base' and 'portal'.
No. (defaults to base)
themeName
String
The theme name - /themes/clients/platform/***THEMENAME***/.
No. (defaults to default)
Request
{
    platform: 'portal',
    themeName: 'default'
}
Response
{
    url: [
        'cache/themes/clients/base/default/bootstrap_97c9cf53841dbe471c20d169e3533763.css',
        'cache/themes/clients/base/default/sugar_14c42516aad866b7f80cc896ce5c5406.css',
    ]
}
Change Log
Version
Change
            v10

            Added /<css> GET endpoint.

  	Last modified: 2023-02-03 21:04:03


/lang/labels/module PUT
Overview
Update display labels of fields for modules under different languages.
Summary
This endpoint is used to update display labels of fields for modules under different languages.
Request Arguments
Name
Type
Description
Required
name
string
The dropdown name.
True
labels
array
The new labels grouped by language keys.
True
Request
[
  {
    "name": "Leads",
    "labels": {
      "en_us": {
          "ai_conv_score_classification_c": "Ai Conv Score Classification"
      },
      "de_DE": {
          "ai_conv_score_classification_c": "Ai Conv Score Klassifizierung"
      },
      "ja_JP": {
          "ai_conv_score_classification_c": "AiConvã¹ã³ã¢åé¡"
      }
    }
  }
]
Â
Request example for multiple fields:
[
  {
    "name": "Leads",
    "labels": {
      "en_us": {
          "ai_score_c": "Ai Score",
          "ai_conv_score_classification_c": "Ai Conv Score Classification",
          "description": "New Description"
      },
      "de_DE": {
          "ai_score_c": "Ai Punktzahl",
          "ai_conv_score_classification_c": "Ai Conv Score Klassifizierung",
          "description": "New German Description"
      },
      "ja_JP": {
          "ai_score_c": "æã¹ã³ã¢",
          "ai_conv_score_classification_c": "AiConvã¹ã³ã¢åé¡",


"description": "New Japanese Description"
      }
    }
  },
  {
    "name": "Opportunities",
    "labels": {
      "de_DE": {
          "amount": "Menge",
          "amount_usdollar": "Betrag US-Dollar"
      },
      "ja_JP": {
          "amount": "é",
          "amount_usdollar": "éé¡ç±³ãã«"
      }
    }
  }
]
Response Example
[
    {
        "name": "Leads",
        "labels": {
            "en_us": {
                "LBL_AI_SCORE": "Ai Score",
                "LBL_AI_CONV_SCORE_CLASSIFICATION": "Ai Conv Score Classification",
                "LBL_DESCRIPTION": "New Description"
            },
            "de_DE": {
                "LBL_AI_SCORE": "Ai Punktzahl",
                "LBL_AI_CONV_SCORE_CLASSIFICATION": "Ai Conv Score Klassifizierung",
                "LBL_DESCRIPTION": "New German Description"
            },
            "ja_JP": {
                "LBL_AI_SCORE": "æã¹ã³ã¢",
                "LBL_AI_CONV_SCORE_CLASSIFICATION": "AiConvã¹ã³ã¢åé¡",
                "LBL_DESCRIPTION": "New Japanese Description"
            }
        }
    },
    {
        "type": "field",
        "module": "Opportunities",
        "labels": {
            "de_DE": {
                "LBL_LIKELY": "Menge",


"de_DE": {
                "LBL_LIKELY": "Menge",
                "LBL_AMOUNT_USDOLLAR": "Betrag US-Dollar"
            },
            "ja_JP": {
                "LBL_LIKELY": "é",
                "LBL_AMOUNT_USDOLLAR": "éé¡ç±³ãã«"
            }
        }
    }
]
Change Log
Version
Change
v11.13
AddedÂ /lang/labels/module/Â PUT endpoint.
  	Last modified: 2023-02-03 21:04:03


/pmse_Project/GatewayDefinition/:record GET
Overview
    Retrieves the definition data for a gateway
Summary
    This endpoint will retrieve the JSON encoded definition data for the Process
    Definition gateway identified by the record input parameter.
Request Arguments
Name
Type
Description
Required
record
String
The value for the gat_uid field in the pmse_bpmn_gateway record
True
Response Arguments
Name
Type
Description
success
Boolean
The status of the response
data
Array
The definition data for the gateway
Response
{
    "success":true,
    "data":
    [
        {
            "flo_uid":"985528634573cabc8901d04029355451",
            "flo_condition":"[{\u0022expType\u0022:\u0022BUSINESS_RULES\u0022,\u0022expLabel\u0022:\u0022Action # 1 is equal to \\\u0022TRUE\\\u0022\u0022,\u0022expValue\u0022:\u0022TRUE\u0022,\u0022expOperator\u0022:\u0022equals\u0022,\u0022expField\u0022:\u0022b6d2500c-bf29-2ad7-67a2-569d5debc7d9\u0022}]"
        }
    ]
}
  	Last modified: 2023-02-03 21:04:03


/Tags/:record PUT
Overview
    Update a record of the specified type.
Request Arguments
Name
Type
Description
Required
            <record field>

            <record field type>

            The name value list of fields to populate.

            True

Request
{
    "name":"New Account Name",
    "phone_office":"(555) 888-5555",
    "website":"www.newsite.com",
    "meetings": {
    {
        "add": ["21e3385e-404f-b470-407e-54044e3d8024"],
        "delete": ["21e3385e-404f-b470-407e-54044e3d8023"],
        "create": [
        {
            "name": "Test Meeting"
        }
      ]
    }
}
Link fields
    It is possible to add or delete record relations to other records and create new related records.
Action
Type
Description
add
            List

            List of related records ID. See RelateRecordApi
            for details.

delete
            List

            List of related records ID.

create
            List

            List of name to value arrays of related records.

Response Arguments
Name
Type
Description
            <record field>

            <record field type>

            Returns the fields for the updated record.

Response
{
   "id":"f222265a-b755-da89-0bc7-512d09b800b6",
   "name":"New Account Name",
   "date_entered":"2013-02-26T19:12:00+00:00",


"date_modified":"2013-02-27T22:49: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_sarah_id",
   "assigned_user_name":"Sarah Smith",
   "team_name":[
      {
         "id":1,
         "name":"Global",
         "name_2":"",
         "primary":false
      },
      {
         "id":"West",
         "name":"West",
         "name_2":"",
         "primary":true
      }
   ],
   "linkedin":"",
   "facebook":"",
   "twitter":"",
   "googleplus":"",
   "account_type":"Customer",
   "industry":"Hospitality",
   "annual_revenue":"",
   "phone_fax":"",
   "billing_address_street":"9 IBM Path",
   "billing_address_street_2":"",
   "billing_address_street_3":"",
   "billing_address_street_4":"",
   "billing_address_city":"San Francisco",
   "billing_address_state":"CA",
   "billing_address_postalcode":"43635",
   "billing_address_country":"USA",
   "rating":"",
   "phone_office":"(555) 888-5555",
   "phone_alternate":"",
   "website":"www.newsite.com",
   "ownership":"",
   "employees":"",
   "ticker_symbol":"",


"ownership":"",
   "employees":"",
   "ticker_symbol":"",
   "shipping_address_street":"9 IBM Path",
   "shipping_address_street_2":"",
   "shipping_address_street_3":"",
   "shipping_address_street_4":"",
   "shipping_address_city":"San Francisco",
   "shipping_address_state":"CA",
   "shipping_address_postalcode":"43635",
   "shipping_address_country":"USA",
   "email1":"kid86@example.net",
   "parent_id":"",
   "sic_code":"",
   "parent_name":"",
   "email_opt_out":false,
   "invalid_email":false,
   "email":[
      {
         "email_address":"kid86@example.net",
         "opt_out":"0",
         "invalid_email":"0",
         "primary_address":"1"
      },
      {
         "email_address":"the.dev@example.name",
         "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 PUT endpoint.

  	Last modified: 2023-02-03 21:04:03


/Administration/elasticsearch/routing GET
Overview
    [ADMIN] Elasticsearch index routing
Summary
    This endpoint returns an overview of the current read and write indices per module. This routing information is
    based on the configured index routing strategies and the index configuration per module. Note that this output
    shows the default routing only as no context is available to determine dynamic routing strategies. This endpoint
    is only available to administrators.
Response
{
    "Contacts":{
        "strategy":"static",
        "routing":{
            "write_index":"autobr2583_contacts",
            "read_indices":[
                "autobr2583_contacts"
            ]
        }
    },
    "Accounts":{
        "strategy":"static",
        "routing":{
            "write_index":"autobr2583_shared",
            "read_indices":[
                "autobr2583_shared"
            ]
        }
    },
    "Emails":{
        "strategy":"rolling",
        "routing":{
            "write_index":"autobr2583_emails_201503",
            "read_indices":[
                "autobr2583_emails_201503",
                "autobr2583_emails_201502",
                "autobr2583_emails_201501"
            ]
        }
    }
}
Change Log
Version
Change
            v10

            Added /Administration/elasticsearch/routing GET endpoint.

  	Last modified: 2023-02-03 21:04:03


/Administration/search/status GET
Overview
    [ADMIN] Search status
Summary
    This endpoint returns the status of the search backend including a list of the activated full text search modules.
    This endpoint is only available to administrators.
Response
{
    "available":true,
    "enabled_modules":
    [
        "Accounts",
        "Bugs",
        "Calls",
        "Campaigns",
    ]
}
Change Log
Version
Change
            v10

            Added /Administration/search/status GET endpoint.

  	Last modified: 2023-02-03 21:04:03


/rssfeed GET
Overview
    Consumes an RSS feed as a proxy and returns the feed up to a certain number of entries.
Request Arguments
Name
Type
Description
Required
feed_url
String
A fully qualified URL to an RSS feed.
True
limit
Integer
Maximum number of entries to fetch. If not provided, the API will return up to $sugar_config['rss_feed_max_entries'] or 20 if no config option is set.
False
Request
http://{site_url}/rest/v10/rssfeed?feed_url=http%3A%2F%2Ffqd.rssfeed.url%2F&limit=10
Note: GET endpoint parameters are passed in the form of a query string.
Response Arguments
Name
Type
Description
title
String
The title of the RSS Feed. This can be blank.
link
String
The URL to the source of the RSS Feed. This can be blank.
description
String
A description of the feed. This can be blank.
publication_date
Timestamp
A timestamp of when the feed was published.
entries
Array
                An array of entries, each of which will contain the following values:
                title
description
link
publication_date
source
author
Response
{
    "feed":{
        "title":"Sample Feed Title",
        "link":"http:\/\/www.samplefeed.com\/feed-link-url.htm",
        "description":"A sample of a feed description",
        "publication_date":"Tue, 10 Aug 2014 13:38:55 -0800",
        "entries":[
            {
                "title":"First entry title",
                "description":"A blurb about the first entry. This will be HTML encoded on return.",
                "link":"http:\/\/www.samplefeed.com\/feed-entry-1.htm",


"link":"http:\/\/www.samplefeed.com\/feed-entry-1.htm",
                "publication_date":"Tue, 10 Aug 2014 13:38:55 -0800",
                "source":"Reuters",
                "author":"John Doe"
            },
            {
                "title":"Second entry title",
                "description":"A blurb about the Second entry. This will be HTML encoded on return.",
                "link":"http:\/\/www.samplefeed.com\/feed-entry-2.htm",
                "publication_date":"Tue, 10 Aug 2014 13:38:55 -0800",
                "source":"BBC",
                "author":""
            }
        ]
    }
}
Change Log
Version
Change
            v10

            Added /<rssfeed> GET endpoint.

  	Last modified: 2023-02-03 21:04:03


/<module>/:record/link/:link_name/:remote_id PUT
Overview
    Updates relationship specific information on an existing relationship.
Request Arguments
Name
Type
Description
Required
            <relationship field>

            <relationship field type>

            The name value list of relationship fields to populate. An example is the contact_role field on Opportunities and Contacts.

            True

Request
{
    "contact_role":"Primary Decision Maker"
}
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",
      "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_max_id",
      "assigned_user_name":"Max Jensen",
      "team_name":[
         {
            "id":"East",
            "name":"East",
            "name_2":"",
            "primary":false
         },
         {
            "id":"West",
            "name":"West",
            "name_2":"",


"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",
      "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":"e1c495cb-af17-1b37-dd66-512f934fe155",
      "name":"Bill Edwards",
      "date_entered":"2013-02-28T17:25:00+00:00",
      "date_modified":"2013-02-28T17:25:00+00:00",
      "modified_user_id":"1",
      "modified_by_name":"Administrator",
      "created_by":"1",
      "created_by_name":"Administrator",
      "description":"",
      "img":"",


"description":"",
      "img":"",
      "deleted":false,
      "assigned_user_id":"",
      "assigned_user_name":"",
      "team_name":[
         {
            "id":1,
            "name":"Global",
            "name_2":"",
            "primary":true
         }
      ],
      "salutation":"",
      "first_name":"Bill",
      "last_name":"Edwards",
      "full_name":"Bill Edwards",
      "title":"",
      "linkedin":"",
      "facebook":"",
      "twitter":"",
      "googleplus":"",
      "department":"",
      "do_not_call":false,
      "phone_home":"",
      "email":[
      ],
      "phone_mobile":"",
      "phone_work":"",
      "phone_other":"",
      "phone_fax":"",
      "email1":"",
      "email2":"",
      "invalid_email":"",
      "email_opt_out":"",
      "primary_address_street":"",
      "primary_address_street_2":"",
      "primary_address_street_3":"",
      "primary_address_city":"",
      "primary_address_state":"",
      "primary_address_postalcode":"",
      "primary_address_country":"",
      "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":"",
      "account_id":"",


"lead_source":"",
      "account_id":"",
      "opportunity_role_fields":"",
      "opportunity_role_id":"",
      "opportunity_role":"Primary Decision Maker",
      "reports_to_id":"",
      "report_to_name":"",
      "portal_name":"",
      "portal_active":false,
      "portal_password":"",
      "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/:remote_id PUT endpoint.

  	Last modified: 2023-02-03 21:04:03


/<module>/sync_key/:sync_key_field_value PATCH
Overview
Upserts based on sync_key. If a record can be found with sync_key, then update. If the record does not exist, then create it.
Note:Â This endpoint cannot be used to set the sync_key for an existing Sugar record. To do so, it is recommended to use the set sync key endpoint to update the matching Sugar record ID. Once the sync_key is set for the record, then it is possible to leverage this endpoint.
Request Arguments
Name
Type
Description
Required
module
String
The module the record belongs to
True
sync_key_field_value
String
A unique ID for the record identifying it in an external system
True
Request
/<module>/sync_key/:sync_key_field_value
Response Arguments
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 /<module>/sync_key/:sync_key_field_valueÂ PATCH endpoint.
  	Last modified: 2023-02-03 21:04:03


/Notifications 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


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


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


$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


]
}
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"


{
               _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


/login/marketingContentUrl GET
Overview
Returns the SugarCRM marketing content URL that is managed by the marketing team.
Summary
This API attempts to reach SugarCRM's marketing content URL. If the service is unreachable, a URL for the static content is returned.
Request Arguments
Name
Type
Description
Required
selected_language
String
Code for the desired marketing content language. (Eg. "en_us", "fr_FR"). Providing a certain language code does not guarantee that content returned will be in the provided language. If an invalid language is specified, will assume "en_us".
False. It uses the configured language if this parameter is missing. Defaults to "en_us".
static
Boolean
If set to true, return URL for static marketing content. Defaults to false.
False. If this parameter is missing, the API defaults to the dynamic content url.
Response Arguments
Name
Type
Description
url
String
URL suitable for embedding in an iFrame that links to marketing content from SugarCRM.
Response
"https://www.sugarcrm.com/product-login-page-service/"
Change Log
Version
Change
v11_9
Added /login/marketingContentUrlÂ GET endpoint.
  	Last modified: 2023-02-03 21:04:03


/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,
            "timeperiod_shown_backward": 2,
            "forecast_ranges": "show_binary",
            "buckets_dom": "commit_stage_binary_dom",
            "show_binary_ranges": {
                "include": {
                    "min": 70,
                    "max": 100
                },
                "exclude": {
                    "min": 0,
                    "max": 69
                }
            },
            "show_buckets_ranges": {
                "include": {
                    "min": 85,
                    "max": 100
                },
                "upside": {
                    "min": 70,
                    "max": 84
                },
                "exclude": {
                    "min": 0,
                    "max": 69
                }
            },
            "sales_stage_won": [
                "Closed Won"
            ],
            "sales_stage_lost": [
                "Closed Lost"
            ],


],
            "sales_stage_lost": [
                "Closed Lost"
            ],
            "show_worksheet_likely": 1,
            "show_worksheet_best": 1,
            "show_worksheet_worst": 0,
            "show_projected_likely": 1,
            "show_projected_best": 1,
            "show_projected_worst": 0,
            "show_forecasts_commit_warnings": 1
        }

Output Example:
        {
            "is_setup": 1,
            "is_upgrade": 0,
            "has_commits": 1,
            "timeperiod_type": "chronological",
            "timeperiod_interval": "Annual",
            "timeperiod_leaf_interval": "Quarter",
            "timeperiod_start_date": "2013-01-01",
            "timeperiod_shown_forward": 2,
            "timeperiod_shown_backward": 2,
            "forecast_ranges": "show_binary",
            "buckets_dom": "commit_stage_binary_dom",
            "show_binary_ranges": {
                "include": {
                    "min": 70,
                    "max": 100
                },
                "exclude": {
                    "min": 0,
                    "max": 69
                }
            },
            "show_buckets_ranges": {
                "include": {
                    "min": 85,
                    "max": 100
                },
                "upside": {
                    "min": 70,
                    "max": 84
                },
                "exclude": {
                    "min": 0,
                    "max": 69
                }
            },
            "sales_stage_won": [
                "Closed Won"
            ],


"sales_stage_won": [
                "Closed Won"
            ],
            "sales_stage_lost": [
                "Closed Lost"
            ],
            "show_worksheet_likely": 1,
            "show_worksheet_best": 1,
            "show_worksheet_worst": 0,
            "show_projected_likely": 1,
            "show_projected_best": 1,
            "show_projected_worst": 0,
            "show_forecasts_commit_warnings": 1
        }

  	Last modified: 2023-02-03 21:04:03


/Administration/settings/idmMode POST
Overview
    [ADMIN] Turn IDM-mode on.
Summary
    This endpoint switches IDM mode on. This endpoint is only available to administrators when IDM migration is turned on and intended for internal use for IDM integration.
Request to enable IDM-mode.
{"idmMode":
    {
        "enabled": true,
        "clientId": "mangoOIDCClientId",
        "clientSecret": "mangoOIDCClientSecret",
        "stsUrl": "http://sts.sugarcrm.local",
        "idpUrl": "http://login.sugarcrm.local",
        "stsKeySetId": "mangoOIDCKeySet",
        "tid": "srn:cloud:idp:eu:0000000001:tenant",
        "crmOAuthScope": "https://apis.sugarcrm.com/auth/crm",
        "requestedOAuthScopes": ["offline", "https://apis.sugarcrm.com/auth/crm", "profile", "email", "address", "phone"],
        "cloudConsoleUrl": "http://console.sugarcrm.local",
        "allowedSAs": ["srn:cloud:iam:us-west-2:9999999999:sa:user-sync"]
    }
}
Refer to multiverse documenation for parameters explanation.
Response when IDM mode has been enabled
{
    "tid": "srn:cloud:idp:eu:0000000001:tenant",
    "clientId": "mangoOIDCClientId",
    "clientSecret": "mangoOIDCClientSecret",
    "stsUrl": "http://sts.sugarcrm.local",
    "idpUrl": "http://login.sugarcrm.local",
    "redirectUri": "http://sugar",


"redirectUri": "http://sugar",
    "urlAuthorize": "http://sts.sugarcrm.local/oauth2/auth",
    "urlAccessToken": "http://sts.sugarcrm.local/oauth2/token",
    "urlResourceOwnerDetails": "http://sts.sugarcrm.local/oauth2/introspect",
    "urlUserInfo": "http://sts.sugarcrm.local/userinfo",
    "http_client": [],
    "cloudConsoleUrl": "http://console.sugarcrm.local",
    "cloudConsoleRoutes": [],
    "caching": [],
    "crmOAuthScope": "https://apis.sugarcrm.com/auth/crm",
    "requestedOAuthScopes": [
        "offline",
        "https://apis.sugarcrm.com/auth/crm",
        "profile",
        "email",
        "address",
        "phone"
    ],
    "keySetId": "mangoOIDCKeySet",
    "urlKeys": "http://sts.sugarcrm.local/keys/mangoOIDCKeySet",
    "allowedSAs": ["srn:cloud:iam:us-west-2:9999999999:sa:user-sync"]
}
Change Log
Version
Change
            v11_2

            Added /Administration/settings/idmMode POST endpoint.

  	Last modified: 2023-02-03 21:04:03


/Emails POST
Overview
    Create a new Emails record.
Summary
    Used for creating an archived email, creating a draft to send later, or creating and sending an email.
Creating an Archived Email
Request Arguments
Name
Type
Description
Required
                state

                String

                Use "Archived" to create an archived email. "Archived" is the default value if this argument is not
                provided.

                False

                name

                String

                The email's subject.

                False

                description_html

                String

                The email's HTML body.

                False

                description

                String

                The email's plain text body. This field is not necessary unless the text body is different from the HTML
                body.

                False

                raw_source

                String

                The complete raw source of the email showing the headers and content in one document.

                False

                date_sent

                String

                The date that the email was sent/received.

                False

                message_id

                String

                The email's unique identifier.

                False

                message_uid

                String

                Only use this field for importing emails downloaded from an IMAP server, as this is the email's IMAP
                UID.

                False

                assigned_user_id

                String

                The assigned user's ID.

                False

                parent_type

                String

                The parent record's module.

                False

                parent_id

                String


False

                parent_id

                String

                The parent record's ID.

                False

                team_name

                List

                List of teams that can access the email.

                False

                from

                Object

                The email's sender. Existing EmailParticipants records cannot be used; only the create action is
                supported. Metadata about the sender is required to link the record.

parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
                        or Users, out out of the box. These fields are not necessary if only an email address is known
                        for the sender.

email_address_id is the ID of the email address the sender used to send the email. To get
                        the ID of the email address, first make a request to /EmailAddresses POST. If this
                        argument is not provided, then the primary email address of the parent record is used.

                True

                to

                Object

                The email's recipients found in the TO field. Existing EmailParticipants records cannot be used; only
                the create action is supported. Metadata about each recipient is required to link the records.

parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
                        or Users, out out of the box. These fields are not necessary if only an email address is known
                        for the recipient.

email_address_id is the ID of the email address the recipient used in the email. To get
                        the ID of the email address, first make a request to /EmailAddresses POST. If this
                        argument is not provided, then the primary email address of the parent record is used.

                False

                cc


False

                cc

                Object

                The email's recipients found in the CC field. Existing EmailParticipants records cannot be used; only
                the create action is supported. Metadata about each recipient is required to link the records.

parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
                        or Users, out out of the box. These fields are not necessary if only an email address is known
                        for the recipient.

email_address_id is the ID of the email address the recipient used in the email. To get
                        the ID of the email address, first make a request to /EmailAddresses POST. If this
                        argument is not provided, then the primary email address of the parent record is used.

                False

                bcc

                Object

                The email's recipients found in the BCC field. Existing EmailParticipants records cannot be used; only
                the create action is supported. Metadata about each recipient is required to link the records.

parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
                        or Users, out out of the box. These fields are not necessary if only an email address is known
                        for the recipient.

email_address_id is the ID of the email address the recipient used in the email. To get
                        the ID of the email address, first make a request to /EmailAddresses POST. If this
                        argument is not provided, then the primary email address of the parent record is used.

                False

                attachments

                Object

                The email's attachments. Existing Notes records cannot be used as email attachments; only the
                create action is supported. Metadata about each attachment is required to link the records.


create action is supported. Metadata about each attachment is required to link the records.

filename_guid is the temporary file ID for an uploaded file to attach as a Notes record.

upload_id is the ID of an existing file that the Notes record should reference as the
                        attachment. This allows files to be shared by multiple Notes records, to preserve space.

                        When using upload_id, file_source should be provided to indicate from where the
                        file originated. The value should be the module of the record that shares its ID with the file.
                        So when an attachment comes from an email template, file_source should be
                        EmailTemplates. And when an attachment comes from a document, file_source should
                        be DocumentRevisions.

                False

Request
{
  "state": "Archived",
  "name": "Re: Discuss Proposal",
  "description": "Now is a good time",
  "description_html": "
Now is a good time
",
  "date_sent": "2012-02-17T06:53:00-08:00",
  "message_id": "<d9c165d0-8863-ba61-dc85-51ed8016c476@example.com>",
  "assigned_user_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
  "parent_type": "Leads",
  "parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6",
  "team_name": [{
    "id": "1",
    "display_name": "Global",
    "name": "Global",
    "name_2": "",
    "primary": true,


"name_2": "",
    "primary": true,
    "selected": false
  }],
  "from": {
    "create": [{
      "parent_type": "Leads",
      "parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6"
    }]
  },
  "to": {
    "create": [{
      "parent_type": "Users",
      "parent_id": "9c61c46a-a7c5-df71-481c-51d48232f820"
    }]
  },
  "cc": {
    "create": [{
      "parent_type": "Contacts",
      "parent_id": "79b9c194-7d79-11e7-8fc5-3c15c2d582c6"
    }, {
      "parent_type": "Users",
      "parent_id": "79c2e800-7d79-11e7-84af-3c15c2d582c6"
      "email_address_id": "79cc341e-7d79-11e7-8748-3c15c2d582c6"
    }]
  },
  "bcc": {
    "create": [{
      "email_address_id": "ac804842-7d78-11e7-a809-3c15c2d582c6"
    }]
  },
  "attachments": {
    "create": [{
      "filename_guid": "afe9702e-53a3-0efb-6bbe-56c3580885ef",
      "name": "Quote.pdf",
      "filename": "Quote.pdf"


"name": "Quote.pdf",
      "filename": "Quote.pdf"
    }]
  }
}
Response
{
  "id": "a028341c-ba92-9343-55e7-56cf5beda121",
  "date_entered": "2016-02-25T11:53:07-08:00",
  "created_by": "9c61c46a-a7c5-df71-481c-51d48232f820",
  "created_by_name": "Sarah Smith",
  "date_modified": "2016-02-25T11:53:07-08:00",
  "modified_by_name": "Sarah Smith",
  "modified_user_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
  "deleted": false,
  "assigned_user_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
  "assigned_user_name": "Sarah Smith",
  "state": "Archived",
  "name": "Re: Discuss Proposal",
  "description": "Now is a good time",
  "description_html": "
Now is a good time
",
  "date_sent": "2012-02-17T06:53:00-08:00",
  "message_id": "",
  "message_uid": "",
  "reply_to_status": false,
  "total_attachments": 1,
  "parent_name": "Tom Davis",
  "parent_type": "Leads",


"parent_name": "Tom Davis",
  "parent_type": "Leads",
  "parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6"
  "team_count": "",
  "team_name": [{
    "id": 1,
    "name": "Global",
    "name_2": "",
    "primary": true,
    "selected": false
  }],
  "my_favorite": false,
  "_acl": {
    "fields": {}
  },
  "_module": "Emails"
}
Creating a Draft
Request Arguments
Name
Type
Description
Required
                state

                String

                Use "Draft" to save a draft.

                True

                outbound_email_id

                String

                The ID of the chosen SMTP configuration for sending an email. Only use this field when saving a draft
                or sending an email. The user's default SMTP configuration is used if one hasn't been chosen prior to
                sending.

                False

                name

                String

                The email's subject.

                False

                description_html

                String

                The email's HTML body.

                False

                description

                String

                The email's plain text body. This field is not necessary unless the text body is different from the HTML
                body.

                False

                reply_to_id

                String

                Only use this field when saving a draft or sending an email that is a reply to another email. This is
                the ID of that other email.

                False


the ID of that other email.

                False

                parent_type

                String

                The parent record's module.

                False

                parent_id

                String

                The parent record's ID.

                False

                to

                Object

                The email's recipients found in the TO field. Existing EmailParticipants records cannot be used; only
                the create action is supported. Metadata about each recipient is required to link the records.

parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
                        or Users, out out of the box. These fields are not necessary if only an email address is known
                        for the recipient.

email_address_id is the ID of the email address the recipient used in the email. To get
                        the ID of the email address, first make a request to /EmailAddresses POST. If this
                        argument is not provided, then the primary email address of the parent record is used.

                False

                cc

                Object

                The email's recipients found in the CC field. Existing EmailParticipants records cannot be used; only
                the create action is supported. Metadata about each recipient is required to link the records.

parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
                        or Users, out out of the box. These fields are not necessary if only an email address is known
                        for the recipient.

email_address_id is the ID of the email address the recipient used in the email. To get
                        the ID of the email address, first make a request to /EmailAddresses POST. If this
                        argument is not provided, then the primary email address of the parent record is used.


argument is not provided, then the primary email address of the parent record is used.

                False

                bcc

                Object

                The email's recipients found in the BCC field. Existing EmailParticipants records cannot be used; only
                the create action is supported. Metadata about each recipient is required to link the records.

parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
                        or Users, out out of the box. These fields are not necessary if only an email address is known
                        for the recipient.

email_address_id is the ID of the email address the recipient used in the email. To get
                        the ID of the email address, first make a request to /EmailAddresses POST. If this
                        argument is not provided, then the primary email address of the parent record is used.

                False

                attachments

                Object

                The email's attachments. Existing Notes records cannot be used as email attachments; only the
                create action is supported. Metadata about each attachment is required to link the records.

filename_guid is the temporary file ID for an uploaded file to attach as a Notes record.

upload_id is the ID of an existing file that the Notes record should reference as the
                        attachment. This allows files to be shared by multiple Notes records, to preserve space.

                        When using upload_id, file_source should be provided to indicate from where the
                        file originated. The value should be the module of the record that shares its ID with the file.
                        So when an attachment comes from an email template, file_source should be
                        EmailTemplates. And when an attachment comes from a document, file_source should
                        be DocumentRevisions.

                False

Request
{


be DocumentRevisions.

                False

Request
{
  "state": "Draft",
  "outbound_email_id": "b80adf1a-7d78-11e7-855a-3c15c2d582c6",
  "name": "Re: Discuss Proposal",
  "description_html": "
Calling you now.
",
  "reply_to_id": "a028341c-ba92-9343-55e7-56cf5beda121",
  "parent_type": "Leads",
  "parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6",
  "to": {
    "create": [{
      "parent_type": "Leads",
      "parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6"
    }]
  },
  "cc": {
    "create": [{
      "parent_type": "Contacts",
      "parent_id": "79b9c194-7d79-11e7-8fc5-3c15c2d582c6"
    }, {
      "parent_type": "Users",
      "parent_id": "79c2e800-7d79-11e7-84af-3c15c2d582c6"
      "email_address_id": "79cc341e-7d79-11e7-8748-3c15c2d582c6"
    }]
  },
  "bcc": {
    "create": [{


}]
  },
  "bcc": {
    "create": [{
      "email_address_id": "ac804842-7d78-11e7-a809-3c15c2d582c6"
    }]
  },
  "attachments": {
    "create": [{
      "upload_id": "a028341c-ba92-9343-55e7-56cf5beda121",
      "name": "Contract.pdf",
      "filename": "Contract.pdf",
      "file_source": "DocumentRevisions"
    }, {
      "upload_id": "18a72782-4514-11e6-a5f7-3c15c2d582c6",
      "name": "survey.doc",
      "filename": "survey.doc",
      "file_source": "EmailTemplates"
    }]
  }
}
Response
{
  "id": "f3c85966-7d27-11e7-9e9e-3c15c2d582c6",
  "date_entered": "2016-02-25T11:53:07-08:00",
  "created_by": "9c61c46a-a7c5-df71-481c-51d48232f820",
  "created_by_name": "Sarah Smith",
  "date_modified": "2016-02-25T11:53:07-08:00",
  "modified_by_name": "Sarah Smith",
  "modified_user_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
  "deleted": false,


"deleted": false,
  "assigned_user_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
  "assigned_user_name": "Sarah Smith",
  "state": "Draft",
  "outbound_email_id": "b80adf1a-7d78-11e7-855a-3c15c2d582c6",
  "name": "Re: Discuss Proposal",
  "description": "Now is a good time",
  "description_html": "
Now is a good time
",
  "date_sent": "2012-02-17T11:53:07-08:00",
  "message_id": "",
  "message_uid": "",
  "reply_to_id": "a028341c-ba92-9343-55e7-56cf5beda121",
  "reply_to_status": false,
  "total_attachments": 2,
  "parent_name": "Tom Davis",
  "parent_type": "Leads",
  "parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6"
  "team_count": "",
  "team_name": [{
    "id": 1,
    "name": "Global",
    "name_2": "",
    "primary": true,
    "selected": false
  }],
  "my_favorite": false,
  "_acl": {
    "fields": {}
  },
  "_module": "Emails"
}
Sending an Email
Request Arguments
Name
Type
Description
Required
                state

                String


Name
Type
Description
Required
                state

                String

                Use "Ready" to send an email.

                True

                outbound_email_id

                String

                The ID of the chosen SMTP configuration for sending an email. Only use this field when saving a draft
                or sending an email. The user's default SMTP configuration is used if one hasn't been chosen prior to
                sending.

                False

                name

                String

                The email's subject.

                False

                description_html

                String

                The email's HTML body.

                False

                description

                String

                The email's plain text body. This field is not necessary unless the text body is different from the HTML
                body.

                False

                reply_to_id

                String

                Only use this field when saving a draft or sending an email that is a reply to another email. This is
                the ID of that other email.

                False

                parent_type

                String

                The parent record's module.

                False

                parent_id

                String

                The parent record's ID.

                False

                to

                Object

                The email's recipients found in the TO field. Existing EmailParticipants records cannot be used; only
                the create action is supported. Metadata about each recipient is required to link the records.

parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
                        or Users, out out of the box. These fields are not necessary if only an email address is known


for the recipient.

email_address_id is the ID of the email address the recipient used in the email. To get
                        the ID of the email address, first make a request to /EmailAddresses POST. If this
                        argument is not provided, then the primary email address of the parent record is used.

                False

                cc

                Object

                The email's recipients found in the CC field. Existing EmailParticipants records cannot be used; only
                the create action is supported. Metadata about each recipient is required to link the records.

parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
                        or Users, out out of the box. These fields are not necessary if only an email address is known
                        for the recipient.

email_address_id is the ID of the email address the recipient used in the email. To get
                        the ID of the email address, first make a request to /EmailAddresses POST. If this
                        argument is not provided, then the primary email address of the parent record is used.

                False

                bcc

                Object

                The email's recipients found in the BCC field. Existing EmailParticipants records cannot be used; only
                the create action is supported. Metadata about each recipient is required to link the records.

parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
                        or Users, out out of the box. These fields are not necessary if only an email address is known
                        for the recipient.

email_address_id is the ID of the email address the recipient used in the email. To get
                        the ID of the email address, first make a request to /EmailAddresses POST. If this


argument is not provided, then the primary email address of the parent record is used.

                False

                attachments

                Object

                The email's attachments. Existing Notes records cannot be used as email attachments; only the
                create action is supported. Metadata about each attachment is required to link the records.

filename_guid is the temporary file ID for an uploaded file to attach as a Notes record.

upload_id is the ID of an existing file that the Notes record should reference as the
                        attachment. This allows files to be shared by multiple Notes records, to preserve space.

                        When using upload_id, file_source should be provided to indicate from where the
                        file originated. The value should be the module of the record that shares its ID with the file.
                        So when an attachment comes from an email template, file_source should be
                        EmailTemplates. And when an attachment comes from a document, file_source should
                        be DocumentRevisions.

                False

Request
{
  "state": "Ready",
  "outbound_email_id": "b80adf1a-7d78-11e7-855a-3c15c2d582c6",
  "name": "Discuss Proposal",
  "description_html": "
When is a good time for us to chat?
",
  "parent_type": "Leads",
  "parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6",
  "to": {
    "create": [{
      "parent_type": "Leads",


"create": [{
      "parent_type": "Leads",
      "parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6"
    }]
  },
  "cc": {
    "create": [{
      "parent_type": "Users",
      "parent_id": "79c2e800-7d79-11e7-84af-3c15c2d582c6"
      "email_address_id": "79cc341e-7d79-11e7-8748-3c15c2d582c6"
    }]
  },
  "attachments": {
    "create": [{
      "upload_id": "a028341c-ba92-9343-55e7-56cf5beda121",
      "name": "Contract.pdf",
      "filename": "Contract.pdf",
      "file_source": "DocumentRevisions"
    }, {
      "upload_id": "18a72782-4514-11e6-a5f7-3c15c2d582c6",
      "name": "survey.doc",
      "filename": "survey.doc",
      "file_source": "EmailTemplates"
    }]
  }
}
Response
{
  "id": "a7795664-7def-11e7-8add-3c15c2d582c6",
  "date_entered": "2016-02-25T08:53:07-08:00",
  "created_by": "9c61c46a-a7c5-df71-481c-51d48232f820",
  "created_by_name": "Sarah Smith",


"created_by_name": "Sarah Smith",
  "date_modified": "2016-02-25T08:53:07-08:00",
  "modified_by_name": "Sarah Smith",
  "modified_user_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
  "deleted": false,
  "assigned_user_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
  "assigned_user_name": "Sarah Smith",
  "state": "Archived",
  "outbound_email_id": "b80adf1a-7d78-11e7-855a-3c15c2d582c6",
  "name": "Discuss Proposal",
  "description": "When is a good time for us to chat?",
  "description_html": "
When is a good time for us to chat?
",
  "date_sent": "2012-02-17T08:53:07-08:00",
  "message_id": "<a7795664-7def-11e7-8add-3c15c2d582c6@example.com>",
  "message_uid": "",
  "reply_to_id": "",
  "reply_to_status": false,
  "total_attachments": 2,
  "parent_name": "Tom Davis",
  "parent_type": "Leads",
  "parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6"
  "team_count": "",
  "team_name": [{
    "id": 1,
    "name": "Global",


"id": 1,
    "name": "Global",
    "name_2": "",
    "primary": true,
    "selected": false
  }],
  "my_favorite": false,
  "_acl": {
    "fields": {}
  },
  "_module": "Emails"
}
Change Log
Version
Change
            v10

            Added /Emails POST endpoint.

  	Last modified: 2023-02-03 21:04:03


/Contact/:record/Cases GET
Overview
Get a contact's related cases, filtered by an expression, which are accessible to a contact with portal visibility.
Summary
This endpoint will return a set of cases filtered by an expression which are accessible to a contact with portal visibility. 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 anAND. 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.
Request
        GET /Contact/:id/Cases
Request Arguments
Name
Type
Description
Required
filter
String
See the Filter API for details.
False
filter_id
String
Identifier for a pre-existing filter. See the Filter API for details.
False
max_num
Integer
Max number of records that can be returned. Default is 20, unless overruled by your Sugar configuration.
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 field's ID and date_modified will always be returned. For more details on additional field parameters, see the Relate API and Collection API.
False
order_by
String
See the Filter API.
False
deleted
Boolean
Boolean to show deleted records in the result set.
False
Response
{
  "next_offset": -1,
  "records": [
    {


{
  "next_offset": -1,
  "records": [
    {
      "id": "d509b3da-29f6-7b23-7cce-56fab1a6335b",
      "name": "Need help",
      "date_modified": "2016-03-29T09:46:00-07:00",
      "_acl": {
        "fields": {}
      },
      "_module": "Cases"
    },
    {
      "id": "cc4982cd-0bdf-bad4-d079-56fab4bdddf1",
      "name": "Having trouble",
      "date_modified": "2016-03-29T09:57:58-07:00",
      "_acl": {
        "fields": {}
      },
      "_module": "Cases"
    }
  ]
}
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.
Change Log
Version
Change
v11
Added /Contact/:record/Cases GET endpoint.
  	Last modified: 2023-02-03 21:04:03


/Activities GET
Activities on the home page
Summary:
  This endpoint lists activities across the entire sytstem. It uses a subscription model, and can be queried like a normal bean collection, but without search, ordering or filtering.
Query Parameters:
ParamDescriptionOptionalmax_numA maximum number of records to returnOptionaloffsetHow many records to skip over before records are returnedOptional
Input Example:
This endpoint does not accept any input
Output Example:
{
    "next_offset": 20, This will be set to -1 when there are no more records after this "page".
    "records": [{
        "id": "22fb8b16-de1d-f1dc-b15b-51240efde177",
        "date_entered": "2013-02-19T23:47:11+00:00",
        "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": []
        },
        "fields": [],
        "first_name": null,


},
        "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