Endpoints
The following sections contain the in-app help documentation for the REST endpoints.
Topics
Retrieves the config settings for a given module.
Retrieves the config settings for a given module.
Lists filtered records.
Create a new custom field for a specified module.
Delete a custom field for a specified module.
Runs a duplicate check against specified data.
Retrieves the enum values for a specific field.
Returns a record set in CSV format along with HTTP headers to indicate content type.
Opportunity Favorites Help
Opportunity Favorites Help
Imports a person record from a vcard.
Lists filtered records.
Lists filtered records.
Lists filtered records.
Lists filtered records.
This endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the
This endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the
Insert new node after target node.
Insert new node before target node.
An API to mass delete records.
An API to mass update records.
Append new node to target node as first child.
Opportunity Recent Product Help
Opportunity Recent Product Help
An API to create and save lists of records.
An API to delete lists of records
An API to return record list data
Deletes the record with the given sync_key.
Retrieves the record with the given sync_key.
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.
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.
Saves an image to a temporary folder.
Reads a temporary image and deletes it.
Lists related filtered records.
Activities on the home page
Activities on the home page
[ADMIN] Gets Amazon Web Services configs from Sugar Serve.
[ADMIN] Set Amazon Web Services configs in Sugar Serve.
[ADMIN] Get Configuration Settings for a Category.
[ADMIN] Set Configuration Settings for a Category.
[ADMIN] Elasticsearch index statistics
[ADMIN] Elasticsearch mapping
[ADMIN] Elasticsearch queue statistics
[ADMIN] Elasticsearch enable refresh_interval
Creates a relationship to a pre-existing email.
Creates relationships to a pre-existing email from a record list.
Lists filtered emails.
Lists filtered emails.
Lists filtered records.
Lists filtered records.
Lists filtered records.
Retrieves an attached file for a specific field on a record.
Attaches a file to a field on a record.
This endpoint takes a file or image and saves it to a record that already contains an attachment in the specified field. The PUT method is very similar to the POST method but differs slightly in how the request is constructed. PUT requests should send the file data as the body of the request. Optionally, a filename query parameter can be sent with the request to assign a name. Additionally, the PUT
Lists filtered records.
Retrieve a Forecasting Information In SugarChart Format
Retrieve a Forecasting Information In SugarChart Format
Lists filtered records.
Returns a collection of ForecastManagerWorksheet models
Returns a collection of ForecastManagerWorksheet models
Returns a collection of ForecastManagerWorksheet models
Assign Quotas to All Reporting Users for a given timeperiod
Returns a record set in CSV format along with HTTP headers to indicate content type.
Returns a collection of ForecastManagerWorksheet models
Returns a collection of ForecastManagerWorksheet models
Updates a record of a specified type as a favorite for the current user.
Retrieve a Forecasting Information In SugarChart Format
Projected Manager Data
This endpoint is used to return the json Data not already in client view for the Forecasts rep projected panel.
ForecastsQuotasApi - Get
ForecastsQuotasApi - Get
Creates and/or updates the config settings for the Forecasts module
Creates and/or updates the config settings for the Forecasts module
ForecastsApi Timeperiod filter info
This endpoint is used to return initialization data for the Forecasts module.
ForecastsApi Reportees
This endpoint is used to return a user's id, user_name, full_name, first_name, last_name, and is_manager param given a user's id.
Returns a collection of ForecastWorksheet models
Saves a collection of ForecastWorksheet models
Returns a collection of ForecastWorksheet models
Returns a collection of ForecastWorksheet models
Returns a record set in CSV format along with HTTP headers to indicate content type.
Returns a collection of ForecastWorksheet models
Returns a collection of ForecastWorksheet models
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".
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".
This endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the
This endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the
Returns a list with the processes for Process Management
Deprecated endpoint.
Clear the PMSE.log file log
Deletes a process note
Claims the processes to the current user
Evaluates the response of the user form Show Process [Approve, Reject, Route]
Returns a list of Processes by user
Return the text of the PMSE.log file
Gets the history log for a process
Returns the notes list for a process
Deprecated endpoint.
Call methods to reassign processes
Retrieve information to reassign processes
Deprecated endpoint.
Deprecated endpoint.
Creates a new note for a process
Retrieve settings for the PA engine
Update settings for the SugarBPMTM engine
Retrieves the processes to show on Unattended Process view
Deprecated endpoint.
Lists filtered records.
Exports a .bpm file with a Process Definition
Verifies whether the Process Definition has any pending processes
Retrieves the definition data for an activity
Updates the definition data for an activity
Retrieves information about Fields, Modules, Users, Roles, etc.
Updates information about Fields, Modules, Users, Roles, etc.
Retrieves the definition data for an event
Updates the definition data for an event
Imports a Process Definition from a .bpm file
Retrieves the definition data for a gateway
Updates the definition data for a gateway
Retrieves the schema data to be used by the Process Definition designer
Updates the schema data from the Process Definition designer
Validates information about Fields, Modules, Users, Roles, etc.
This endpoint is designed to return a paged recordset of one level of product templates and product categories in
This endpoint is designed to return a paged recordset of one level of product templates and product categories in
Quote Convert to Opportunity
Quote Config GET Help
Quote Config POST Help
Returns all of the current users recently viewed records.
An API to run a saved report and export the result.
An API to get chart data for a saved report.
An API to get total number of filtered records from a saved report.
An API to deliver filtered records from a saved report.