id
stringlengths 14
16
| text
stringlengths 33
5.27k
| source
stringlengths 105
270
|
|---|---|---|
fb1763d242d0-2
|
get_module_fields_md5 method was added.
get_module_layout method was added.
get_module_layout_md5 method was added.
get_relationships had the parameter $order_by added.
get_upcoming_activities method was added.
search_by_module had the parameter $assigned_user_id added.
search_by_module had the parameter $select_fields added.
v2_1
get_entry_list method logic was modified.
get_report_entries method logic was modified.
md5 method was removed.
v2 (REST API was introduced into SugarCRM)
get_available_modules method was added.
get_document_revision method was added.
get_entries method was added.
get_entries_count method was added.
get_entry method was added.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/REST_Release_Notes/index.html
|
fb1763d242d0-3
|
get_entries_count method was added.
get_entry method was added.
get_entry_list method was added.
get_module_fields method was added.
get_note_attachment method was added.
get_relationships method was added.
get_report_entries method was added.
get_server_info method was added.
get_user_id method was added.
get_user_team_id method was added.
login method was added.
logout method was added.
md5 method was added.
seamless_login method was added.
search_by_module method was added.
set_campaign_merge method was added.
set_document_revision method was added.
set_entries method was added.
set_entry method was added.
set_note_attachment method was added.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/REST_Release_Notes/index.html
|
fb1763d242d0-4
|
set_entry method was added.
set_note_attachment method was added.
set_relationship method was added.
set_relationships method was added.SOAP Release Notes
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/REST_Release_Notes/index.html
|
bb86442a12a6-0
|
SugarHttpClient
Overview
The SugarHttpClient class is used to make REST calls.
The SugarHttpClient Class
The SugarHttpClient class is located in 'include/SugarHttpClient.php'. It contains a callRest() method that will allow you to post a request to a REST service via cURL without having to worry about the overhead or the restrictions on the file_get_contents() method when doing outbound webservice calls.
Making a Request
<?php
// specify the REST web service to interact with
$url = 'http://{sugar_url}/service/v4_1/rest.php';
// Open a SugarHttpClient session for making the call
require_once('include/SugarHttpClient.php');
$client = new SugarHttpClient;
// Set the POST arguments to pass to the Sugar server
$parameters = array(
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/SugarHttpClient/index.html
|
bb86442a12a6-1
|
$parameters = array(
'user_auth' => array(
'user_name' => 'username',
'password' => md5('password'),
),
);
$json = json_encode($parameters);
$postArgs = array(
'method' => 'login',
'input_type' => 'JSON',
'response_type' => 'JSON',
'rest_data' => $json,
);
$postArgs = http_build_query($postArgs);
// Make the REST call, returning the result
$response = $client->callRest($url, $postArgs);
if ( $response === false )
{
die("Request failed.\n");
}
// Convert the result from JSON format to a PHP array
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/SugarHttpClient/index.html
|
bb86442a12a6-2
|
}
// Convert the result from JSON format to a PHP array
$result = json_decode($response);
if ( !is_object($result) )
{
die("Error handling result.\n");
}
if ( !isset($result->id) )
{
die("Error: {$result->name} - {$result->description}\n.");
}
// Get the session id
$sessionId = $result->id;
?>
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/SugarHttpClient/index.html
|
ca5abdc4c07a-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
Methods
Web Service Method Calls.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/index.html
|
ca5abdc4c07a-1
|
Topicsget_available_modulesRetrieves a list of available modules in the system.get_document_revisionRetrieves a specific document revision.get_entriesRetrieves a list of beans based on specified record IDs.get_entries_countRetrieves a list of beans based on query specifications.get_entryRetrieves a single bean based on record ID.get_entry_listRetrieves a list of beans based on query specifications.get_language_definitionRetrieves the language label strings for the specified modules.get_last_viewedRetrieves a list of recently viewed records by module for the current user.get_modified_relationshipsRetrieves a list of modified relationships between a specific date range. Helps facilitate sync operations for users.get_module_fieldsRetrieves the list of field vardefs for a specific module.get_module_fields_md5Retrieves the
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/index.html
|
ca5abdc4c07a-2
|
for a specific module.get_module_fields_md5Retrieves the MD5 hash of the vardefs for the specified modules.get_module_layoutRetrieves the layout metadata for a given module given a specific type and view.get_module_layout_md5Retrieves the MD5 hash value for a layout given a specific module, type and view.get_note_attachmentRetrieves an attachment associated with a specific note record.get_quotes_pdfGenerates a quote PDF for a specific quote.get_relationshipsRetrieves a specific relationship link for a specified record.get_report_entriesRetrieves a list of report entries based on specified record IDs.get_report_pdfGenerates a PDF for a specific report.get_server_infoRetrieves info about the SugarCRM instance.get_upcoming_activitiesRetrieves a list of upcoming activities for the current
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/index.html
|
ca5abdc4c07a-3
|
instance.get_upcoming_activitiesRetrieves a list of upcoming activities for the current user.get_user_idRetrieves the id of the user currently logged in.get_user_team_idRetrieves the ID of the default team of the user who is logged into the current session.job_queue_cycleRuns through the scheduler cleanup process and cycles the scheduler jobs.job_queue_nextRetrieves the next job from the job queue and marks it as 'In Progress'.job_queue_runRuns the specified job.loginLogs a user into the SugarCRM application.logoutLogs a user out of the SugarCRM application.oauth_accessRetrieves the OAuth access token.seamless_loginVerifies that a session is authenticated.search_by_moduleSearches modules for a string and returns matched records.set_campaign_mergeHandles campaign log entry
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/index.html
|
ca5abdc4c07a-4
|
modules for a string and returns matched records.set_campaign_mergeHandles campaign log entry creation for mail-merge activity given a specified campaign.set_document_revisionCreates a new document revision for a specific document record.set_entriesCreate or update a list of records.set_entryCreates or updates a specific record.set_note_attachmentCreates an attachment and associated it to a specific note record.set_relationshipSets relationships between two records. You can relate multiple records to a single record using this.set_relationshipsSets multiple relationships between mulitiple record sets.snip_import_emailsUsed to imports an email record from the SNIP archiving service.snip_update_contactsRetrieves new contact emails since a timestamp for the current user.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/index.html
|
ca5abdc4c07a-5
|
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/index.html
|
568be5adaccd-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
set_entry
Overview
Creates or updates a specific record.
Available APIs
SOAP
REST
Definition
set_entry(session, module_name, name_value_list)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
module_name
String
The name of the module from which to retrieve records. Note: This is the modules key which may not be the same as the modules display name.
name_value_list
name_value_list | Array
The name/value list of the record attributes.
Result
Name
Type
Description
result
new_set_entry_result | Array
The call result.
result.id
String
The ID of the record that was created/updated.
Change Log
Version
Change
v2
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_entry/index.html
|
568be5adaccd-1
|
Change Log
Version
Change
v2
Return type was changed from set_entry_result to new_set_entry_result.
Considerations
To update an existing record, you will need to specify 'id' in the name_value_list parameter.
To create a new record with a specific ID, you will need to set 'new_with_id' in the name_value_list parameter.
Examples
PHP
$set_entry_parameters = array(
//session id
"session" => $session_id,
//The name of the module from which to retrieve records.
"module_name" => "Accounts",
//Record attributes
"name_value_list" => array(
//to update a record
/*
array(
"name" => "id",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_entry/index.html
|
568be5adaccd-2
|
/*
array(
"name" => "id",
"value" => "da0b107d-cfbc-cb08-4f90-50b7b9cb9ad7"
),
*/
//to create a new record with a specific ID
/*
array(
"name" => "new_with_id",
"value" => true
),
*/
array(
"name" => "name",
"value" => "Example Account"
),
),
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_entry/index.html
|
ea46524c2068-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
get_document_revision
Overview
Retrieves a specific document revision.
Available APIs
SOAP
REST
Definition
get_document_revision(session, i)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
i
String
The ID of the document revision.
Result
Name
Type
Description
result
new_return_document_revision| Array
The call result.
result.document_revision
Array
The details of the document revision.
result.document_revision.id
String
The document ID.
result.document_revision.document_name
String
The document name.
result.document_revision.revision
String
The document revision number
result.document_revision.filename
String
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_document_revision/index.html
|
ea46524c2068-1
|
String
The document revision number
result.document_revision.filename
String
The filename of the file.
result.document_revision.file
String
The binary contents of the file.
Change Log
Version
Change
v2
Return type was changed from return_document_revision to new_return_document_revision.
Examples
PHP
$get_document_revision_parameters = array(
//Session id
"session" => $session_id,
//The attachment details
"i" => '723b7dcb-27b3-e53d-b348-50bd283f8e48',
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_document_revision/index.html
|
e2a0afbf7277-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
get_note_attachment
Overview
Retrieves an attachment associated with a specific note record.
Available APIs
SOAP
REST
Definition
get_note_attachment(session, id)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
id
String
The ID of the note record to associate the attachment to.
Result
Name
Type
Description
result
new_return_note_attachment | Array
The call result.
result.note_attachment
Array
The details of the file attachment.
result.note_attachment.id
String
The ID of the note record / attachment.
result.note_attachment.filename
String
The filename of the attachment.
result.note_attachment.file
String
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_note_attachment/index.html
|
e2a0afbf7277-1
|
String
The filename of the attachment.
result.note_attachment.file
String
The binary contents of the file.
result.note_attachment.related_module_id
String
The related parent ID.
result.note_attachment.related_module_name
String
The related parent module.
Change Log
Version
Change
v2
Return type was changed from return_note_attachment to new_return_note_attachment.
Examples
PHP
$get_note_attachment_parameters = array(
//Session id
"session" => $session_id,
//The ID of the note containing the attachment.
'id' => "9057784d-de17-4f28-c5f9-50bd0f260a43",
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_note_attachment/index.html
|
1815ad168f61-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
get_entry
Overview
Retrieves a single bean based on record ID.
Available APIs
SOAP
REST
Definition
get_entry(session, module_name, id, select_fields, link_name_to_fields_array, track_view)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
module_name
String
The name of the module from which to retrieve records. Note: This is the modules key which may not be the same as the modules display name.
id
String
The ID of the record to retrieve.
select_fields
select_fields | Array
The list of fields to be returned in the results. Specifying an empty array will return all fields.
link_name_to_fields_array
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_entry/index.html
|
1815ad168f61-1
|
link_name_to_fields_array
link_names_to_fields_array | Array
A list of link names and the fields to be returned for each link.
track_view
Boolean
Flag the record as a recently viewed item.
Result
Name
Type
Description
result
get_entry_result_version2 | Array
The call result.
result.entry_list
Array
The record's name-value pair for the simple datatypes excluding the link field data. If you do not have access to the object, entry_list[].name_value_list will notify you.
result.relationship_list
Array
The records link field data.
Change Log
Version
Change
v3_1
Added track_view parameter.
v2
Added link_name_to_fields_array parameter.
v2
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_entry/index.html
|
1815ad168f61-2
|
v2
Added link_name_to_fields_array parameter.
v2
Return type was changed from get_entry_result to get_entry_result_version2.
Examples
PHP
$get_entry_parameters = array(
//session id
'session' => $session_id,
//The name of the module from which to retrieve records
'module_name' => "Contacts",
//The ID of the record to retrieve.
'id' => "18df70e4-1422-8bff-6f5f-50aa571fe4e5",
//The list of fields to be returned in the results
'select_fields' => array(
'id',
'first_name',
'last_name',
),
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_entry/index.html
|
1815ad168f61-3
|
'first_name',
'last_name',
),
//A list of link names and the fields to be returned for each link name
'link_name_to_fields_array' => array(
array(
'name' => 'email_addresses',
'value' => array(
'email_address',
'opt_out',
'primary_address'
),
),
),
//Flag the record as a recently viewed item
'track_view' => true,
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_entry/index.html
|
c8ed3720cb2d-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
job_queue_run
Overview
Runs the specified job.
Available APIs
REST
Definition
job_queue_run(session, jobid, clientid)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
jobid
String
The ID of the job to run.
clientid
String
The client id calling the application. This parameter is of your choosing for the calling application.
Result
Name
Type
Description
result
Array
The call result.
result.results
Boolean
The result of the job run.
result.message
String
This is only returned if a failure occurs.
Change Log
Version
Change
v4
Added job_queue_run method.
Examples
PHP
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/job_queue_run/index.html
|
c8ed3720cb2d-1
|
Change
v4
Added job_queue_run method.
Examples
PHP
$job_queue_run_parameters = array(
//Session id
'session' => $session_id,
//The ID of the job to run.
'jobid' => 'd141efd3-d2c7-8a9c-9c02-50c11b491f16',
//The ID of the calling application.
'clientid' => 'MyAppID',
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/job_queue_run/index.html
|
23e4b231d8ae-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
get_last_viewed
Overview
Retrieves a list of recently viewed records by module for the current user.
Available APIs
SOAP
REST
Definition
get_last_viewed(session, module_names)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
module_names
module_names | Array
The list of modules to retrieve last viewed records for.
Result
Name
Type
Description
result
last_viewed_list | Array
The call result. Contains a list of reciently viewed records.
result[].id
Integer
The result ID.
result[].item_id
String
The reciently viewed record ID.
result[].item_summary
String
The name of the reciently viewed record.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_last_viewed/index.html
|
23e4b231d8ae-1
|
result[].item_summary
String
The name of the reciently viewed record.
result[].module_name
String
The name of the module.
result[].monitor_id
String
The monitor ID from the tracker table.
result[].date_modified
String
The date the record was viewed.
Change Log
Version
Change
Examples
PHP
$get_last_viewed_parameters = array(
//Session id
"session" => $session_id,
//The name of the modules to retrieve last viewed for
'module_names' => array(
'Contacts',
'Accounts'
),
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_last_viewed/index.html
|
8c739af790c6-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
get_modified_relationships
Overview
Retrieves a list of modified relationships between a specific date range. Helps facilitate sync operations for users.
Available APIs
SOAP
REST
Definition
get_modified_relationships(session, module_name, related_module, from_date, to_date, offset, max_results, deleted, module_user_id, select_fields, relationship_name, deletion_date)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
module_name
String
The module key to retrieve relationships against.
related_module
String
The related module key to retrieve records off of. This parameter should always be 'Users'.
from_date
String
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_modified_relationships/index.html
|
8c739af790c6-1
|
from_date
String
Start date in YYYY-MM-DD HH:MM:SS format for the date range.
to_date
String
End date in YYYY-MM-DD HH:MM:SS format for the date range.
offset
Integer
The offset to begin returning records from.
max_results
Integer
The max_results to return.
deleted
Integer
Whether or not to include deleted records. Set to 1 to find deleted records.
module_user_id
String
*This parameter is no longer used and is only present for backward compatibility purposes.
select_fields
select_fields
List of fields to select and return as name/value pairs.
relationship_name
String
The name of the relationship name to search on.
deletion_date
String
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_modified_relationships/index.html
|
8c739af790c6-2
|
The name of the relationship name to search on.
deletion_date
String
Date value in YYYY-MM-DD HH:MM:SS format for filtering on deleted records whose date_modified falls within range.
Result
Name
Type
Description
result
modified_relationship_result | Array
The call result.
result.result_count
Integer
The result count.
result.next_offset
Integer
The next offset to retrieve from.
result.entry_list
Array
List of found records.
result.error
Array
Error Message.
result.error.number
Integer
The error number.
result.error.name
String
The name of the error.
result.error.description
String
The description of the error.
Change Log
Version
Change
v4_1
Added get_modified_relationships method.
Considerations
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_modified_relationships/index.html
|
8c739af790c6-3
|
Change
v4_1
Added get_modified_relationships method.
Considerations
The module_name parameter should always be 'Users'.
Examples
PHP
$get_modified_relationships_parameters = array(
//Session id
'session' => $session_id,
//The module key to retrieve relationships against.
//This parameter should always be 'Users'.
'module_name' => 'Users',
//The related module key to retrieve records off of.
'related_module' => 'Meetings',
//Start date in YYYY-MM-DD HH:MM:SS format for the date range.
'from_date' => '2000-01-01 01:01:01',
//End date in YYYY-MM-DD HH:MM:SS format for the date range
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_modified_relationships/index.html
|
8c739af790c6-4
|
'to_date' => '2013-01-01 01:01:01',
//The offset to begin returning records from.
'offset' => 0,
//The max_results to return.
'max_results' => 5,
//Whether or not to include deleted records. Set to 1 to find deleted records.
'deleted' => 0,
//This parameter is not used.
'module_user_id' => '',
//List of fields to select and return as name/value pairs.
'select_fields' => array(),
//The name of the relationship name to search on.
'relationhip_name' => 'meetings_users',
//Date value in YYYY-MM-DD HH:MM:SS format for filtering on deleted records.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_modified_relationships/index.html
|
8c739af790c6-5
|
'deletion_date' => '2012-01-01 01:01:01'
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_modified_relationships/index.html
|
7c6a3f56ea37-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
set_note_attachment
Overview
Creates an attachment and associated it to a specific note record.
Available APIs
SOAP
REST
Definition
set_note_attachment(session, note)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
note
new_note_attachment | Array
The file attachment details
note.id
String
The ID of the note record to associate the attachment to.
note.filename
String
The file name of the file attachment.
note.file
String
The binary contents of the file.
Result
Name
Type
Description
result
new_set_entry_result | Array
The call result.
result.id
String
The ID of the note record / attachment
Change Log
Version
Change
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_note_attachment/index.html
|
7c6a3f56ea37-1
|
String
The ID of the note record / attachment
Change Log
Version
Change
v2
Return type was changed from set_entry_result to new_set_entry_result.
v2
Parameter note type change from note_attachment to new_note_attachment.
Examples
PHP
$file_contents = file_get_contents("/path/to/example_file.php");
$set_note_attachment_parameters = array(
//Session id
"session" => $session_id,
//The attachment details
"note" => array(
//The ID of the note containing the attachment.
'id' => $note_id,
//The file name of the attachment.
'filename' => 'example_file.php',
//The binary contents of the file.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_note_attachment/index.html
|
7c6a3f56ea37-2
|
//The binary contents of the file.
'file' => base64_encode($file_contents),
),
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_note_attachment/index.html
|
24944d5d07db-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
get_upcoming_activities
Overview
Retrieves a list of upcoming activities for the current user.
Available APIs
SOAP
REST
Definition
get_upcoming_activities(session)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
Result
Name
Type
Description
result
upcoming_activities_list | Array
The call result. Contains a list of upcoming activity records.
result[].id
Integer
The record ID.
result[].module
String
The activity module.
result[].date_due
String
The date the activity is due.
result[].summary
String
The summary of the activity.
Change Log
Version
Change
Examples
PHP
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_upcoming_activities/index.html
|
24944d5d07db-1
|
The summary of the activity.
Change Log
Version
Change
Examples
PHP
$get_upcoming_activities_parameters = array(
//Session id
"session" => $session_id,
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_upcoming_activities/index.html
|
0864cff20b63-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
get_report_pdf
Overview
Generates a PDF for a specific report.
Available APIs
REST
Definition
get_report_pdf(session, report_id)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
report_id
String
The ID of the report record to generate the PDF for.
Result
Name
Type
Description
result
Array
The call result.
result.file_contents
String
The binary contents of the PDF file.
Change Log
Version
Change
v3_1
Added get_report_pdf method.
Examples
PHP
$get_report_pdf_parameters = array(
//Session id
'session' => $session_id,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_report_pdf/index.html
|
0864cff20b63-1
|
//Session id
'session' => $session_id,
//The report to generate the pdf for.
'report_id' => '68ca4de9-7486-72e1-1a56-50aa5757aaab',
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_report_pdf/index.html
|
891784b01c05-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
set_entries
Overview
Create or update a list of records.
Available APIs
SOAP
REST
Definition
set_entries(session, module_name, name_value_lists)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
module_name
String
The name of the module from which to retrieve records. Note: This is the modules key which may not be the same as the modules display name.
name_value_lists
name_value_lists | Array
The an array of name/value lists containing the record attributes.
Result
Name
Type
Description
result
new_set_entries_result | Array
The call result.
result.ids
Array
The list of record IDs that were created or updated
Change Log
Version
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_entries/index.html
|
891784b01c05-1
|
Array
The list of record IDs that were created or updated
Change Log
Version
Change
v2
Return type was changed from set_entry_result to new_set_entries_result.
Considerations
To update an existing record, you will need to specify 'id' for the name_value_list item in the name_value_lists parameter.
To create a new record with a specific ID, you will need to set 'new_with_id' in the name_value_list item in the name_value_lists parameter.
Examples
PHP
$set_entries_parameters = array(
//Session id
"session" => $session_id,
//The name of the module from which to retrieve records.
"module_name" => "Accounts",
//Record attributes
"name_value_lists" => array(
array(
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_entries/index.html
|
891784b01c05-2
|
"name_value_lists" => array(
array(
//to update a record
/*
array(
"name" => "id",
"value" => "da0b107d-cfbc-cb08-4f90-50b7b9cb9ad7"
),
*/
//to create a new record with a specific ID
/*
array(
"name" => "new_with_id",
"value" => 1
),
*/
array(
"name" => "name",
"value" => "Example Account 1"
),
),
array(
//to update a record
/*
array(
"name" => "id",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_entries/index.html
|
891784b01c05-3
|
/*
array(
"name" => "id",
"value" => "da0b107d-cfbc-cb08-4f90-50b7b9cb9ad7"
),
*/
//to create a new record with a specific ID
/*
array(
"name" => "new_with_id",
"value" => 1
),
*/
array(
"name" => "name",
"value" => "Example Account 2"
),
),
)
,);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_entries/index.html
|
22c207c1d2c5-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
get_user_id
Overview
Retrieves the id of the user currently logged in.
Available APIs
SOAP
REST
Definition
get_user_id(session)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
Result
Name
Type
Description
id
String
The users ID.
Change Log
Version
Change
Examples
PHP
$get_user_id_parameters = array(
//Session id
"session" => $session_id,
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_user_id/index.html
|
d5aaa7973941-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
login
Overview
Logs a user into the SugarCRM application.
Available APIs
SOAP
REST
Definition
login(user_auth, application_name, name_value_list)
Parameters
Name
Type
Description
user_auth
user_auth | Array
Contains the parameters to authenticate a user.
user_auth.user_name
String
The user name of your user
user_auth.password
String
The MD5 hash of the users password.
application name
String
The name of the application logging in.
name_value_list
name_value_list | Array
Sets the name_value pair. The parameter is used to set values for the 'language' and 'notifyonsave' user settings.
name_value_list.language
String
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/login/index.html
|
d5aaa7973941-1
|
name_value_list.language
String
The language for the user.
name_value_list.notifyonsave
Boolean
Alerts users on new record creations when set to true.
Result
Name
Type
Description
result
entry_value | Array
The call result
result.id
String
This is the session id required to make other method calls.
result.module_name
String
Returns the 'Users' module.
result.name_value_list
Array
Authenticated user properties.
result.name_value_list.user_id
String
ID of the authenitcated user.
result.name_value_list.user_name
String
Username of the authenticated user.
result.name_value_list.user_language
String
Default language of the authenticated user.
result.name_value_list.user_currency_id
String
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/login/index.html
|
d5aaa7973941-2
|
result.name_value_list.user_currency_id
String
Default currency ID of the authenticated user.
result.name_value_list.user_is_admin
String
Admin status of the authenticated user.
result.name_value_list.user_default_team_id
String
Default team of the authenticated user.
result.name_value_list.user_default_dateformat
String
Default date format for the authenticated user.
result.name_value_list.user_default_timeformat
String
Default time format for the authenticated user.
result.name_value_list.user_number_seperator
String
Number seperator for the authenticated user.
result.name_value_list.user_decimal_seperator
String
Decimal sperator for the authenticated user.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/login/index.html
|
d5aaa7973941-3
|
String
Decimal sperator for the authenticated user.
result.name_value_list.mobile_max_list_entries
String
Max list entires for the authenticated user.
result.name_value_list.mobile_max_subpanel_entries
String
Max subpanel entries for the authenticated user.
result.name_value_list.user_currency_name
String
Default currency name for the authenticated user.
Change Log
Version
Change
v3_1
Added additional return values to name_value_list. The list now also includes user_number_seperator, user_decimal_seperator, mobile_max_list_entries, mobile_max_subpanel_entries.
v3
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/login/index.html
|
d5aaa7973941-4
|
v3
Added additional return values to name_value_list. The list now also includes user_is_admin, user_default_team_id, user_default_dateformat, user_default_timeformat.
v2
Added name_value_list to response. Returns user_id, user_name, user_language, user_currency_id, user_currency_name.
v2
Added module_name to response.
v2
Removed error from response.
v2
Added name_value_list parameter
v2
Return type was changed from set_entry_result to entry_value.
Examples
PHP
$login_parameters = array(
//user authentication
"user_auth" => array(
"user_name" => $username,
"password" => md5($password),
),
//application name
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/login/index.html
|
d5aaa7973941-5
|
"password" => md5($password),
),
//application name
"application_name" => "My Application",
//name value list for 'language' and 'notifyonsave'
"name_value_list" => array(
array(
'name' => 'language',
'value' => 'en_us',
),
array(
'name' => 'notifyonsave',
'value' => true
),
),
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/login/index.html
|
0405b4aae138-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
logout
Overview
Logs a user out of the SugarCRM application.
Available APIs
SOAP
REST
Definition
logout(session)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous call to login.
Result
Name
Type
Description
null
void
No return value.
Change Log
Version
Change
v2
Return type was changed from error_value to void.
Example
PHP
$logout_parameters = array(
//session id to expire
"session" => $session_id,
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/logout/index.html
|
2f663f036d98-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
snip_update_contacts
Overview
Retrieves new contact emails since a timestamp for the current user.
Available APIs
REST
Definition
snip_update_contacts(session, report_id)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
report_id
String
The ID of the report record to generate the PDF for.
Result
Name
Type
Description
result
Array
The call result.
result.results
Boolean
The new emails.
result.count
Integer
The count of results.
result.message
String
The return message.
Change Log
Version
Change
v4
Added snip_update_contacts method.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/snip_update_contacts/index.html
|
5be661d7daef-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
get_user_team_id
Overview
Retrieves the ID of the default team of the user who is logged into the current session.
Available APIs
SOAP
REST
Definition
get_user_team_id(session)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
Result
Name
Type
Description
default_team_id
Integer
The ID of the current users default ream
Change Log
Version
Change
v2
Added get_user_team_id method.
Examples
PHP
$get_user_team_id_parameters = array(
//Session id
"session" => $session_id,
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_user_team_id/index.html
|
c7c540043a6e-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
get_quotes_pdf
Overview
Generates a quote PDF for a specific quote.
Available APIs
REST
Definition
get_quotes_pdf(session, quote_id, pdf_format)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
quote_id
String
The ID of the quote record to generate the PDF for.
pdf_format
String
The pdf type requested. 'Standard' is an example.
Result
Name
Type
Description
result
Array
The call result.
result.file_contents
String
The binary contents of the PDF file.
Change Log
Version
Change
v3_1
Added get_quotes_pdf method.
Examples
PHP
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_quotes_pdf/index.html
|
c7c540043a6e-1
|
v3_1
Added get_quotes_pdf method.
Examples
PHP
$get_quotes_pdf_parameters = array(
//Session id
'session' => $session_id,
//The quote to generate the pdf for
'quote_id' => '490cc844-f83a-9b74-9888-50aa575b517c',
//The pdf type
'pdf_format' => 'Standard',
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_quotes_pdf/index.html
|
2b20f98e5fef-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
get_server_info
Overview
Retrieves info about the SugarCRM instance.
Available APIs
SOAP
REST
Definition
get_server_info()
Parameters
Name
Type
Description
null
null
No parameters available.
Result
Name
Type
Description
result
get_server_info_result | Array
The call result.
result.flavor
String
The flavor of the instance.
result.version
String
The version of the instance.
result.gmt_time
String
The GMT time of the server.
Change Log
Version
Change
v2
Method get_server_info was added to replace get_server_time, get_server_version and get_sugar_flavor.
v2
Method get_server_time was removed.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_server_info/index.html
|
2b20f98e5fef-1
|
v2
Method get_server_time was removed.
v2
Method get_server_version was removed.
v2
Method get_sugar_flavor was removed.
Examples
PHP
//this method does not have any parameters
$get_server_info_parameters = array();
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_server_info/index.html
|
72cce97dbcad-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
snip_import_emails
Overview
Used to imports an email record from the SNIP archiving service.
Available APIs
REST
Definition
snip_import_emails(session, email)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
email
Array
The contents of the email being imported.
email.message
Array
Contains the email attributes.
email.message.message_id
String
The ID of the email message.
email.message.subject
String
Email subject.
email.message.attachments
Array
The list of attachments to be imported
email.message.from_name
String
From sender name.
email.message.description
String
Plain text content body.
email.message.description_html
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/snip_import_emails/index.html
|
72cce97dbcad-1
|
String
Plain text content body.
email.message.description_html
String
HTML email content body.
email.message.to_addrs
String
Email addresses the email was sent to.
email.message.cc_addrs
String
Email addresses the email was CCed to.
email.message.bcc_addrs
String
Email addresses the email was BCCed to.
email.message.date_sent
String
Date the email was sent.
Result
Name
Type
Description
result
Array
The call result.
result.results
Boolean
The success of the import.
result.count
Integer
The count of records imported.
result.message
String
The return message.
Change Log
Version
Change
v4
Added snip_import_emails method.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/snip_import_emails/index.html
|
e697af00fd30-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
set_relationships
Overview
Sets multiple relationships between mulitiple record sets.
Available APIs
SOAP
REST
Definition
set_relationships(session, module_names, module_ids, link_field_names, related_ids, name_value_lists, delete_array)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
module_names
select_fields | Array
The list of modules from which to retrieve records. Note: This is the modules key which may not be the same as the modules display name.
module_ids
select_fields | Array
The list of IDs for the specified module records.
link_field_names
select_fields | Array
The list of link names for the related modules.
related_ids
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_relationships/index.html
|
e697af00fd30-1
|
The list of link names for the related modules.
related_ids
new_set_relationhip_ids | Array
The list of related record IDs you are relating.
name_value_lists
name_value_lists | Array
An array of arrays specifying relationship fields to populate. An example of this is contact_role between Opportunities and Contacts.
delete_array
deleted_array | Array
An array determining whether the relationships are being created or deleted. 0:create, 1:delete
Result
Name
Type
Description
result
new_set_relationship_list_result | Array
The call result.
result.created
Integer
The number of relationships created.
result.failed
Integer
Determines whether or not the relationship failed. This is normally thrown when the parameters module_name or link_field_name are incorrect.
result.deleted
Integer
The number of relationships deleted.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_relationships/index.html
|
e697af00fd30-2
|
result.deleted
Integer
The number of relationships deleted.
Change Log
Version
Change
v2
Removed set_relationship_value parameter.
v2
Added module_names parameter.
v2
Added module_ids parameter.
v2
Added link_field_names parameter.
v2
Added related_ids parameter.
v2
Added name_value_lists parameter.
v2
Added delete_array parameter.
v2
Return type was changed from set_relationship_list_result to new_set_relationship_list_result.
Examples
PHP
$set_relationships_parameters = array(
//session id
'session' => $session_id,
//The name of the modules from which to relate records.
'module_names' => array(
'Opportunities',
'Accounts',
),
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_relationships/index.html
|
e697af00fd30-3
|
'Opportunities',
'Accounts',
),
//The IDs of the specified module beans.
'module_ids' => array(
'15e79b92-5025-827f-0784-50aa578270d8', //Opportunity ID
'27035f04-f6ec-492d-b89e-50aa57f5247f' //Account ID
),
//The relationship names of the linked fields from which to relate records.
'link_field_names' => array(
'contacts', //Contacts link field to Opportunities
'leads' //Leads link field to Accounts
),
//The lists of record ids to relate
'related_ids' => array(
//Contact IDs
array(
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_relationships/index.html
|
e697af00fd30-4
|
'related_ids' => array(
//Contact IDs
array(
'19b8799e-64ae-9502-588c-50aa575454c9'
),
//Lead IDs
array(
'16d8d519-5f56-0984-2092-50aa576a7333',
'15ae07eb-63f0-dbac-6e4c-50aa57c5a609'
),
),
//Sets the value for relationship based fields
'name_value_lists' => array(
//Opportunity-Contact relationship fields
array(
array(
'name' => 'contact_role',
'value' => 'Other'
),
),
//Account-Lead relationship fields
array(),
),
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_relationships/index.html
|
e697af00fd30-5
|
),
//Account-Lead relationship fields
array(),
),
//Whether or not to delete the relationships. 0:create, 1:delete
'delete_array'=> array(
0, //Opportunity-Contact
0 //Account-Lead
),
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_relationships/index.html
|
dc4ee6395c6c-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
get_language_definition
Overview
Retrieves the language label strings for the specified modules.
Available APIs
REST
Definition
get_available_modules(session, modules, md5)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
modules
Array
The list of modules to retrieve language definitions for.
md5
Boolean
Setting this to true will return an MD5 hash of the modules labels strings instead of the label strings themselves.
Result
Name
Type
Description
result
Array
The call result. Contains a list of modules.
result[]
Array or String
The list of language definitions or MD5 hashes. This is dependent on the 'md5' parameter.
Change Log
Version
Change
v3_1
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_language_definition/index.html
|
dc4ee6395c6c-1
|
Change Log
Version
Change
v3_1
Added get_language_definition method.
Examples
PHP
$get_language_definition_parameters = array(
//Session id
'session' => $session_id,
//The list of modules
'modules' => array(
'Accounts'
),
//Whether to return the results as an MD5 hash
'md5' => false,
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_language_definition/index.html
|
4a00c2446895-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
get_relationships
Overview
Retrieves a specific relationship link for a specified record.
Available APIs
SOAP
REST
Definition
get_relationships(session, module_name, module_id, link_field_name, related_module_query, related_fields, related_module_link_name_to_fields_array, deleted, order_by, offset, limit)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
module_name
String
The name of the module from which to retrieve records. Note: This is the modules key which may not be the same as the modules display name.
module_id
String
The ID of the specified module record.
link_field_name
String
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_relationships/index.html
|
4a00c2446895-1
|
String
The ID of the specified module record.
link_field_name
String
The name of the link field for the related module.
related_module_query
String
The list of related record IDs you are relating
related_fields
select_fields | Array
An array specifying relationship fields to populate. An example of this is contact_role between Opportunities and Contacts.
related_module_link_name_to_fields_array
link_names_to_fields_array | Array
For every related record returned, specify link field names to field information.
deleted
Integer
order_by
String
The SQL ORDER BY clause without the phrase "order by".
offset
Integer
The record offset from which to start.
limit
Integer
The maximum number of results to return.
Result
Name
Type
Description
result
get_entry_result_version2 | Array
The call result.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_relationships/index.html
|
4a00c2446895-2
|
Description
result
get_entry_result_version2 | Array
The call result.
result.entry_list
Array
The record's name-value pair for the simple datatypes excluding the link field data. If you do not have access to the object, entry_list[].name_value_list will notify you.
result.relationship_list
Array
The records link field data.
Change Log
Version
Change
v3
Added order_by parameter.
v2
Removed related_module parameter.
v2
Added link_field_name parameter.
v2
Added related_fields parameter.
v2
Added related_module_link_name_to_fields_array parameter.
v2
Return type was changed from get_relationships_result to get_entry_result_version2.
Examples
PHP
$get_relationships_parameters = array(
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_relationships/index.html
|
4a00c2446895-3
|
Examples
PHP
$get_relationships_parameters = array(
//session id
'session' => $session_id,
//The name of the module from which to retrieve records.
'module_name' => 'Accounts',
//The ID of the specified module bean.
'module_id' => '9f0c0ceb-c512-7103-9456-50aa5787c3f6',
//The relationship name of the linked field from which to return records.
'link_field_name' => 'opportunities',
//The portion of the WHERE clause from the SQL statement used to find the related items.
'related_module_query' => " opportunities.name IS NOT NULL ",
//The related fields to be returned.
'related_fields' => array(
'id',
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_relationships/index.html
|
4a00c2446895-4
|
'related_fields' => array(
'id',
'name'
),
//For every related bean returned,
//specify link field names to field information.
'related_module_link_name_to_fields_array' => array(
array(
'name' => 'contacts',
'value' => array(
'id',
'first_name',
'last_name',
),
),
),
//To exclude deleted records
'deleted'=> 0,
//order by
'order_by' => ' opportunities.name ',
//offset
'offset' => 0,
//limit
'limit' => 200,
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_relationships/index.html
|
b3f5590e82c2-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
get_module_layout_md5
Overview
Retrieves the MD5 hash value for a layout given a specific module, type and view.
Available APIs
REST
Definition
get_module_layout_md5(session, modules, types, views, acl_check)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
modules
Array
The list of modules to retrieve layouts for.
types
Array
The types of views requested. Current supported types are 'default' (for application) and 'wireless'.
views
Array
The views requested. Current supported types are 'edit', 'detail', 'list', and 'subpanel'.
acl_check
Boolean
Whether or not to check for ACL access.
Result
Name
Type
Description
result
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_module_layout_md5/index.html
|
b3f5590e82c2-1
|
Whether or not to check for ACL access.
Result
Name
Type
Description
result
Array
The call result. Contains a list of modules.
result[][$type]
Array
The list of types requested.
result[][$view]
String
The list of MD5 layout view hashes requested.
Change Log
Version
Change
v3_1
Added acl_check parameter.
v3
Added get_module_layout_md5 method.
Examples
PHP
$get_module_layout_md5_parameters = array(
//Session id
'session' => $session_id,
//The list of modules
'modules' => array(
'Accounts'
),
//The types of views requested
'types' => array(
'default',
),
//The views requested
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_module_layout_md5/index.html
|
b3f5590e82c2-2
|
'default',
),
//The views requested
'views' => array(
'edit'
),
//Whether or not to check for ACL access
'acl_check' => false,
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_module_layout_md5/index.html
|
b26d8bbcb7c0-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
set_relationship
Overview
Sets relationships between two records. You can relate multiple records to a single record using this.
Available APIs
SOAP
REST
Definition
set_relationship(session, module_name, module_id, link_field_name, related_ids, name_value_list, delete)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
module_name
String
The name of the module from which to retrieve records. Note: This is the modules key which may not be the same as the modules display name.
module_id
String
The ID of the specified module record.
link_field_name
String
The name of the link field for the related module.
related_ids
select_fields | Array
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_relationship/index.html
|
b26d8bbcb7c0-1
|
related_ids
select_fields | Array
The list of related record IDs you are relating
name_value_list
name_value_list | Array
An array specifying relationship fields to populate. An example of this is contact_role between Opportunities and Contacts.
delete
Integer
Determines whether the relationship is being created or deleted. 0:create, 1:delete
Result
Name
Type
Description
result
new_set_relationship_list_result | Array
The call result
result.created
Integer
The number of relationships created.
result.failed
Integer
Determines whether or not the relationship failed. This is normally thrown when the parameters module_name or link_field_name are incorrect.
result.deleted
Integer
The number of relationships deleted.
Change Log
Version
Change
v2
Removed set_relationship_value parameter.
v2
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_relationship/index.html
|
b26d8bbcb7c0-2
|
Version
Change
v2
Removed set_relationship_value parameter.
v2
Added module_name parameter.
v2
Added module_id parameter.
v2
Added link_field_name parameter.
v2
Added related_ids parameter.
v2
Added name_value_list parameter.
v2
Added delete parameter.
v2
Return type was changed from error_value to new_set_relationship_list_result.
Examples
PHP
$set_relationship_parameters = array(
//session id
'session' => $session_id,
//The name of the module.
'module_name' => 'Opportunities',
//The ID of the specified module bean.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_relationship/index.html
|
b26d8bbcb7c0-3
|
//The ID of the specified module bean.
'module_id' => '15e79b92-5025-827f-0784-50aa578270d8',
//The relationship name of the linked field from which to relate records.
'link_field_name' => 'contacts',
//The list of record ids to relate
'related_ids' => array(
'19b8799e-64ae-9502-588c-50aa575454c9',
),
//Sets the value for relationship based fields
'name_value_list' => array(
array(
'name' => 'contact_role',
'value' => 'Other'
)
),
//Whether or not to delete the relationship. 0:create, 1:delete
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_relationship/index.html
|
b26d8bbcb7c0-4
|
//Whether or not to delete the relationship. 0:create, 1:delete
'delete'=> 0,
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_relationship/index.html
|
9ad235fc276a-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
get_entries_count
Overview
Retrieves a list of beans based on query specifications.
Available APIs
SOAP
REST
Definition
get_entries_count(session, module_name, query, deleted)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
module_name
String
The name of the module from which to retrieve records. Note: This is the modules key which may not be the same as the modules display name.
query
String
The SQL WHERE clause without the word "where".
deleted
Integer
If deleted records should be included in the results.
Result
Name
Type
Description
result
get_entries_count_result | Array
The call result.
result.result_count
Integer
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_entries_count/index.html
|
9ad235fc276a-1
|
The call result.
result.result_count
Integer
The count of total records.
Change Log
Version
Change
Examples
PHP
$get_entries_count_parameters = array(
//Session id
'session' => $session_id,
//The name of the module from which to retrieve records
'module_name' => 'Accounts',
//The SQL WHERE clause without the word "where".
'query' => " accounts.name like '%example text%' ",
//If deleted records should be included in results.
'deleted' => false
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_entries_count/index.html
|
22303d2b4c28-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
get_available_modules
Overview
Retrieves a list of available modules in the system.
Available APIs
SOAP
REST
Definition
get_available_modules(session, filter)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
filter
String
String to filter the modules with. Possible values are 'default', 'mobile', 'all'.
Result
Name
Type
Description
result
new_module_fields | Array
The call result.
result.modules
Array
The list of avaialble modules.
result.modules[].module_key
String
The modules key.
result.modules[].module_label
String
The display label for the module.
result.modules[].favorite_enabled
String
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_available_modules/index.html
|
22303d2b4c28-1
|
The display label for the module.
result.modules[].favorite_enabled
String
Whether favorites are enabled for the module.
result.modules[].acls
Array
The ACL list for the module
Change Log
Version
Change
v3
Added filter parameter. Accepts the values 'default', 'mobile', 'all'.
Examples
PHP
$get_available_modules_parameters = array(
//Session id
"session" => $session_id,
//Module filter. Possible values are 'default', 'mobile', 'all'.
"filter" => 'all',
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_available_modules/index.html
|
ce8220ce8ac5-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
job_queue_cycle
Overview
Runs through the scheduler cleanup process and cycles the scheduler jobs.
Available APIs
REST
Definition
job_queue_cycle(session, clientid)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
clientid
String
The client id calling the application. This parameter is of your choosing for the calling application.
Result
Name
Type
Description
result
Array
The call result.
result.results
String
The cycle result. Returns 'ok' on success.
Change Log
Version
Change
v4
Added job_queue_cycle method.
Examples
PHP
$job_queue_cycle_parameters = array(
//Session id
'session' => $session_id,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/job_queue_cycle/index.html
|
ce8220ce8ac5-1
|
//Session id
'session' => $session_id,
//The ID of the calling application.
'clientid' => 'MyAppID',
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/job_queue_cycle/index.html
|
ed226117dbd6-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
search_by_module
Overview
Searches modules for a string and returns matched records.
Available APIs
SOAP
REST
Definition
search_by_module(session, search_string, modules, offset, max_results, assigned_user_id, select_fields, unified_search_only, favorites)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
search_string
String
The string to search for.
modules
Integer
The list of modules to query.
offset
Integer
The record offset from which to start.
max_results
Integer
The maximum number of records to return.
assigned_user_id
String
Filters records by the assigned user ID. Leave this empty if no filter should be applied.
select_fields
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/search_by_module/index.html
|
ed226117dbd6-1
|
select_fields
select_fields | Array
An array of fields to return. If empty the default return fields will be from the active listviewdefs.
unified_search_only
Boolean
If the search is only against modules participating in the unified search.
favorites
Boolean
If only records marked as favorites should be returned.
Result
Name
Type
Description
result
return_search_result | Array
Call result.
result.entry_list
Array
The count of records in paged result.
result.entry_list[].name
String
The .name of the module
result.entry_list[].records
Array
A list of name_value lists for each record matched.
Change Log
Version
Change
v3_1
Added unified_search_only parameter.
Examples
PHP
$search_by_module_parameters = array(
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/search_by_module/index.html
|
ed226117dbd6-2
|
Examples
PHP
$search_by_module_parameters = array(
//Session id
"session" => $session_id,
//The string to search for.
'search_string' => 'example text',
//The list of modules to query.
'modules' => array(
'Accounts',
),
//The record offset from which to start.
'offset' => 0,
//The maximum number of records to return.
'max_results' => 100,
//Filters records by the assigned user ID.
//Leave this empty if no filter should be applied.
'assigned_user_id' => '',
//An array of fields to return.
//If empty the default return fields will be from the active listviewdefs.
'select_fields' => array(
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/search_by_module/index.html
|
ed226117dbd6-3
|
'select_fields' => array(
'id',
'name',
),
//If the search is only search modules participating in the unified search.
'unified_search_only' => false,
//If only records marked as favorites should be returned.
'favorites' => false
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/search_by_module/index.html
|
228a095b519c-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
oauth_access
Overview
Retrieves the OAuth access token.
Available APIs
REST
Definition
oauth_access()
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
Result
Name
Type
Description
result
Array
The call result.
result.id
String
The OAuth access token.
Change Log
Version
Change
v4
Added oauth_access method.
Examples
PHP
$oauth_access_parameters = array(
//Session id
'session' => $session_id,
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/oauth_access/index.html
|
73ff05886680-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
get_module_fields_md5
Overview
Retrieves the MD5 hash of the vardefs for the specified modules.
Available APIs
SOAP
REST
Definition
get_module_fields_md5(session, module_names)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
module_names
select_fields | Array
The list of modules to retrieve MD5 hashes for.
Result
Name
Type
Description
result
md5_results | Array
The call result. Contains a list of module field hashes. Order is based on the module_names parameter.
Change Log
Version
Change
Examples
PHP
$get_module_fields_md5_parameters = array(
//Session id
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_module_fields_md5/index.html
|
73ff05886680-1
|
//Session id
"session" => $session_id,
//The name of the modules to retrieve field hashes for
'module_names' => array(
'Contacts',
'Accounts'
),
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_module_fields_md5/index.html
|
0bf8f249bce4-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
set_document_revision
Overview
Creates a new document revision for a specific document record.
Available APIs
SOAP
REST
Definition
set_document_revision(session, note)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
note
document_revision | Array
The file attachment details
note.id
String
The ID of the note record to associate the attachment to.
note.file
String
The binary contents of the file.
note.filename
String
The file name of the file attachment.
note.revision
String
The revision number
Result
Name
Type
Description
result
new_set_entry_result | array
The results from the call.
result.id
String
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_document_revision/index.html
|
0bf8f249bce4-1
|
The results from the call.
result.id
String
The ID of the document revision.
Change Log
Version
Change
v2
Return type was changed from set_entry_result to new_set_entry_result.
Examples
PHP
$file_contents = file_get_contents("/path/to/example_document.txt");
$set_document_revision_parameters = array(
//Session id
"session" => $session_id,
//The attachment details
"note" => array(
//The ID of the parent document.
'id' => $document_id,
//The binary contents of the file.
'file' => base64_encode($file_contents),
//The name of the file
'filename' => 'example_document.txt',
//The revision number
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_document_revision/index.html
|
0bf8f249bce4-2
|
'filename' => 'example_document.txt',
//The revision number
'revision' => '1',
),
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_document_revision/index.html
|
a95c6b3f7469-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
set_campaign_merge
Overview
Handles campaign log entry creation for mail-merge activity given a specified campaign.
Available APIs
SOAP
REST
Definition
set_campaign_merge(session, targets, campaign_id)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous call to login.
targets
select_fields | Array
A string array of IDs identifying the targets used in the merge. The IDs used in this parameter come from the column 'prospect_lists_prospects.id'.
campaign_id
String
The campaign ID used for the mail merge.
Result
Name
Type
Description
null
void
No return value.
Change Log
Version
Change
v2
Return type was changed from error_value to void.
Example
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_campaign_merge/index.html
|
a95c6b3f7469-1
|
Change
v2
Return type was changed from error_value to void.
Example
PHP
$set_campaign_merge_parameters = array(
//Session id
"session" => $session_id,
//A string array of IDs identifying the targets used in the merge.
//The IDs used in this parameter come from the column 'prospect_lists_prospects.id'.
"targets" => array(
'403787cc-ab19-bec8-3ef4-50bd4896c9b3',
'c5341c8d-4b0a-2b56-7108-50bd48b91213'
),
//The campaign ID used for the mail merge.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_campaign_merge/index.html
|
a95c6b3f7469-2
|
),
//The campaign ID used for the mail merge.
"campaign_id" => '781d4471-fb48-8dd2-ae62-50bd475950b2'
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_campaign_merge/index.html
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.