Bigin DRE Functions

This parameter indicates the API name of the module in which the record will be created. For example, if you want to create a record in the Companies module, you would pass Accounts as the value of <module_name>.

You can get the API name of modules from Get all modules.

This parameter is a map that provides necessary information to create a new record. The keys indicate the field API names and values indicate the values to be set for corresponding fields. For example, if you want to create a new contact record with Last_name as Williams, you should pass the value of <record_details> in the following format:

<record_details> = {"Last_name":"Williams"}

You can get the field API names from Get all records.

For information about mandatory fields in each module, see Modules and Fields.

This parameter is a map that includes any other optional details such as the execution of scripts or triggering of workflows when a new record is created. For example, if you want to trigger a workflow after the record is created, you should pass the value of <optional_details> in the following format:

<optional_details> = {"trigger":{"workflow"}}

When this parameter is not passed, approvals and stage transition rules execute by default. To prevent all operations from executing, you can pass an empty map with the trigger key set to an empty value.

This parameter indicates the Connection Link Name of a connection. For more information about Connection Link Name, see Connections.

This parameter indicates the API name of the module in which the values of a record with a specified Id are updated. For example, if you want to update the record's values from the Companies module, you would pass Accounts as the value of <module_name>.

You can get the API name of modules from Get all modules.

This parameter indicates the ID of a record within a specified module for which the values are updated.

You can get the ID of a record from Get all records.

This parameter is a map that provides the necessary information to update an existing record. The keys indicate the field API names and values indicate the values to be set for corresponding fields. For example, if you want to update a contact record with Last_name as Williams, you should pass the value of <record_details> in the following format:

<record_details> = {"Last_name":"Williams"}

You can get the field API names from Get all records.

For information about mandatory fields in each module, see Modules and Fields.

This parameter is a map that includes any other optional details such as execution of scripts or triggering of workflows when a record is updated. For example, if you want to trigger a workflow after the record is updated, you should pass the value of <optional_details> in the following format:

<optional_details> = {"trigger":{"workflow"}}

When this parameter is not passed, approvals and stage transition rules execute by default. To prevent all operations from executing, you can pass an empty map with the trigger key set to an empty value.

This parameter indicates the Connection Link Name of a connection. For more information about Connection Link Name, see Connections.

This parameter indicates the API name of the module in which the values of a record with a specified Id are updated or a new record is created. For example, if you want to upsert a record from the Companies module, you would pass Accounts as the value of <module_name>.

You can get the API name of modules from Get all modules.

This parameter is a map that includes the necessary information to update an existing record. The keys indicate the field API names and values indicate the values to be set for corresponding fields. To identify a record, you should provide the record ID along with the updated values. If the record ID is not provided, a new record with the specified values is created. For example, if you want to update a contact record with Last_name as Williams, you should pass the value of <record_details> in the following format:

<record_details> = {"id":"50639489594738889", Last_name":"Williams"}

You can get the field API names from Get all records.

For information about mandatory fields in each module, see Modules and Fields.

This parameter is a map that includes any other optional details such as execution of scripts or triggering of workflows when a record is updated or created. For example, if you want to trigger a workflow after the record is updated or created, you should pass the value of <optional_details> in the following format:

<optional_details> = {"trigger":{"workflow"}}

When this parameter is not passed, approvals and stage transition rules execute by default. To prevent all operations from executing, you can pass an empty map with the trigger key set to an empty value.

This parameter indicates the Connection Link Name of a connection. For more information about Connection Link Name, see Connections.

This parameter indicates the API name of the module from which records are fetched. For example, if you want to fetch records from the Companies module, you would pass Accounts as the value of <module_name>.

You can get the API name of modules from Get all modules.

This parameter is a map that includes request parameters used in the Get Records API. These parameters are especially included to filter and fetch records based on specific conditions.

This parameter indicates the Connection Link Name of a connection. For more information about Connection Link Name, see Connections.

This parameter indicates the API name of the module from which the record with the specified ID is fetched. For example, if you want to fetch a record with the specified ID from the Companies module, you would pass Accounts as the value of <module_name>.

You can get the API name of modules from Get all modules.

This parameter indicates the ID of the record that needs to be fetched.

You can get the ID of a record from Get all records.

This parameter is a map that includes request parameters used in the Get all records. These parameters are especially included to filter and fetch records based on specific conditions.

This parameter indicates the Connection Link Name of a connection. For more information about Connection Link Name, see Connections.

This parameter indicates the API name of a related list from which records are fetched.

You can get the API name of related lists from Get related list metadata.

This parameter indicates the API name of the module from which the related list records are fetched. For example, if you want to fetch related list records from the Companies module, you would pass Accounts as the value of <module_name>.

You can get the API name of modules from Get all modules.

This parameter indicates the ID of a record within a specified module from which the related list records are fetched.

You can get the ID of a record from Get all records.

This parameter is a map that includes request parameters used in the Get related records details. These parameters are especially included to filter and fetch records from related lists based on the specific conditions.

This parameter indicates the Connection Link Name of a connection. For more information about Connection Link Name, see Connections.

This parameter indicates the api name of Bigin variable. To get values of multiple Bigin variables, you can pass more than one variable separated by comma.

This parameter indicates the Connection Link Name of a connection. For more information about Connection Link Name, see Connections.

This parameter invokes function to set the Bigin variables. For set organization variable, you would pass crm.set as the value of <nameSpace>.

This parameter is used when you want to provide additional query parameters for executing the function. To prevent this query parameter from executing, you must pass an empty map. For example: map()

This parameter is a map that includes the header details specified for Bigin. The keys represent the header names and values represent the header values. This parameter is used when you want to provide additional header information for executing the function.

This parameter is a map that includes the necessary information to set a value for Bigin variable. Pass the Payload details in the following format:

variableMap = map();
variableMap.put("apiname", <variable_api_name>);
variableMap.put("value", <value>);
payLoad = map();
payLoad.put("VARIABLES", variableMap);

From the above syntax,
<variable_api_name> represents the api name of Bigin variable.
<value> represents the actual value that is going to be assigned to Bigin variable.

This parameter indicates the Connection Link Name of a connection. For more information about Connection Link Name, see Connections.

This parameter indicates the API name of the module in which multiple records will be created. For example, if you want to create multiple records in the Companies module, you would pass Accounts as the value of <module_name>.

You can get the API name of modules from Get all modules.

This parameter is a list that provides the necessary information to create multiple records. The keys indicate the field API names, and the values indicate the values to be set for corresponding fields. For example, if you want to create multiple contact records, you would pass the value of <record_details> in the following format:

payload = List();

// Record Values to be Created

valueMap1 = Map();
valueMap1.put("First_Name", "Bigin");
valueMap1.put("Last_Name", "By Zoho CRM");
valueMap1.put("Email", "support@bigin.com");
payload.add(valueMap1);

valueMap2 = Map();
valueMap2.put("First_Name", "Bigin");
valueMap2.put("Last_Name", "CRM");
valueMap2.put("Email", "support1@bigin.com");
payload.add(valueMap2);

You can get the field API names from Get all records.

For information about mandatory fields in each module, see Modules and Fields.

This parameter is a map that includes any other optional details such as the execution of scripts or triggering of workflows when multiple records are created. For example, if you want to trigger a workflow after multiple records are added to a module, you should pass the value of <optional_details> in the following format:

<optional_details> = {"trigger":{"workflow"}}

When this parameter is not passed, approvals and stage transition rules execute by default. To prevent all operations from executing, you can pass an empty map with the trigger key set to an empty value.

This parameter indicates the Connection Link Name of a connection. For more information about Connection Link Name, see Connections.

This parameter indicates the API name of the module in which multiple records will be updated. For example, if you want to update multiple records in the Companies module, you would pass Accounts as the value of <module_name>.

You can get the API name of modules from Get all modules.

This parameter is a list that provides the necessary information to create multiple records. The keys indicate the field API names, and the values indicate the values to be set for corresponding fields. For example, if you want to create multiple contact records, you would pass the value of <record_details> in the following format:

payload = List();

// Record Values to be Updated

valueMap1 = Map();
valueMap1.put("id", "554023000000527002");
valueMap1.put("First_Name", "Bigin");
payload.add(valueMap1);

valueMap2 = Map();
valueMap2.put("id", "554023000000527004");
valueMap2.put("Last_Name", "By Zoho CRM");
payload.add(valueMap2);

In the above sample, you must include the ID of the record in each map value, along with the fields that needs to be updated.

You can get the field API names and record IDs from Get all records.

For information about mandatory fields in each module, see Modules and Fields.

This parameter is a map that includes any other optional details such as the execution of scripts or triggering of workflows when multiple records are updated. For example, if you want to trigger a workflow after multiple records are updated in a module, you should pass the value of <optional_details> in the following format:

<optional_details> = {"trigger":{"workflow"}}

When this parameter is not passed, approvals and stage transition rules execute by default. To prevent all operations from executing, you can pass an empty map with the trigger key set to an empty value.

This parameter indicates the Connection Link Name of a connection. For more information about Connection Link Name, see Connections.

This parameter indicates the API name of the module in which the file is attached to a record. For example, if you want to attach a file to a record in the Companies module, you would pass Accounts as the value of <module_name>.

You can get the API name of modules from Get all modules.

This parameter indicates the ID of a record within a specified module to which the file will be attached.

You can get the ID of a record from Get all records.

This parameter indicates the file variable that contains the attachment file.

The <file_object> can be defined as shown in File data type before passing through the function.

This parameter indicates the Connection Link Name of a connection. For more information about Connection Link Name, see Connections.

This parameter invokes function to set the Bigin variables. For getting ZApikey, you would pass crm.zapikey as the value of <nameSpace>.

This parameter is used when you want to provide additional query parameters for executing the function. To prevent this query parameter from executing, you must pass an empty map. For example: map()

This parameter is a map that includes the header details specified for Bigin. The keys represent the header names and values represent the header values. This parameter is used when you want to provide additional header information for executing the function.

This parameter is a map that includes the necessary information to get the ZApikey. Pass the Payload details in the following format:

variableMap = map();
variableMap.put("nameSpace", <portal>.<topping_namespace>);
payLoad = map();
payLoad.put("VARIABLES", variableMap);

From the above syntax,
<portal> represents the portal name of your topping. It can be found in the URL path of your Bigin Developer Console.

<topping_namespace> represents the namespace of your topping. It can be found in the Edit Topping page of your Bigin Developer Console.

This parameter indicates the Connection Link Name of a connection. For more information about Connection Link Name, see Connections.

This parameter is a unique name given to a custom signal, which is generated in the <toppingNamespace>_<signalName> format.

This parameter is a map that includes the necessary information to raise signals. Pass the payload in the following format:

payload = Map();
payload.put("subject", "Bigin Signals");
payload.put("message", "Detailed description of Signals in Bigin");

actionsList = List();

//A sample action property

actionProp1 = Map();
actionProp1.put("type", "link");
actionProp1.put("open_in", "tab");
actionProp1.put("display_name", "Bigin Website Link");
actionProp1.put("url", "www.bigin.com");
actionsList.add(actionProp1);

//If required, multiple action properties can be specified here

payload.put("actions", actionsList);

This parameter is a map that includes the header details specified for Bigin. The keys represent the header names, and the values represent the header values. This parameter is used when you want to provide additional header information for executing the function.

To prevent this query parameter from executing, you must pass an empty map.

This parameter indicates the Connection Link Name of a connection. For more information about Connection Link Name, see Connections.