Update Related Records

Purpose

To update the relation between the records.

PUT /{module_api_name}/{record_id}/{related_list_api_name}/{related_record_id}

Request Details

Request URL

https://www.zohoapis.com/bigin/v1/{module_api_name}/{record_id}/{related_list_api_name}/{related_record_id}

Supported relations

Products - to - Contacts, Deals, Accounts(Companies in Bigin)

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoBigin.modules.ALL
(or)
scope=scope=ZohoBigin.modules.{module_name}.{operation_type}

Possible module names

companies, deals, contacts, products

Possible operation types

ALL - Full access to records
WRITE - Edit related records
UPDATE - Update related records

Sample Request: To add the relation between a Lead and Campaigns

Copiedcurl "https://www.zohoapis.com/bigin/v1/Deals/3652397000001829002/Products"
-X PUT
-d @updaterelateddeal.json
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

CopiedZCRMRecord record = ZCRMRecord.getInstance("Leads", 1234567l);//module api name with record id
ZCRMJunctionRecord relatedRecord = ZCRMJunctionRecord.getInstance("Campaigns", 963258l);
relatedRecord.setRelatedData("Status", "active");
APIResponse response = record.addRelation(relatedRecord);
String recStatus = response.getStatus(); //check status of the update relation

Copiedtry{
$parentRecord=ZCRMRecord::getInstance("Products", 410405000001446001);
$junctionRecord=ZCRMJunctionRecord::getInstance("Price_Books",
410405000001404743);
$junctionRecord->setRelatedData("list_price", 140);
$responseIns=$parentRecord->addRelation($junctionRecord);
echo "HTTP Code:".$responseIns->getHttpStatusCode();
echo "Message:".$responseIns->getMessage();
echo "Code:".$responseIns->getCode();
echo "Details:".$responseIns->getDetails()['id'];
}catch (ZCRMException $e)
{
echo $e->getCode();
echo $e->getMessage();
}

Copieddef add_relation(self):
        try:
            record = ZCRMRecord.get_instance('Leads', 3719520000000323002)  # module API Name, entityId
            junction_record = ZCRMJunctionRecord.get_instance("Products",3719520000000450002)  # module API Name, entityId
            resp = record.add_relation(junction_record)
            print(resp.status_code)
            print(resp.code)
            print(resp.details)
            print(resp.message)
            print(resp.status)
        except ZCRMException as ex:
            print(ex.status_code)
            print(ex.error_message)
            print(ex.error_code)
            print(ex.error_details)
            print(ex.error_content)

CopiedSyntax:
zoho.crm.updateRelatedRecord(<module String>,<recordID Long>,<parentModuleName String>,<parentRecordId Long>,<dataMap Map>,<connectionName String>,<userAccess Boolean>);
mandatory : module,recordID,parentModuleName,parentRecordId,dataMap

Sample Request:
resp = zoho.crm.updateRelatedRecord("Related_List_Name_2","7000000037119","Leads","7000000037002", Map());

CopiedZCRMRecord recordIns = ZCRMRecord.GetInstance("Leads", 337216400000); //module api name with record id
ZCRMJunctionRecord relatedRecord = ZCRMJunctionRecord.GetInstance("Campaigns", 33721640000001); //RelatedList api name with RelatedList record id
relatedRecord.SetRelatedDetails("Status", "active");
APIResponse response = recordIns.AddRelation(relatedRecord);
String recStatus = response.Status; //check status of the update relation
//In the above example, lead with ID 337216400000 gets associated with the campaign with ID 33721640000001.

In this request, products with IDs 3652397000000327001 and 3652397000001854001 get associated with the deal with the ID 3652397000001829002.

In the request, "@updaterelateddeal.json" contains the sample input data.

Copiedcurl "https://www.zohoapis.com/bigin/v1/Deals/3652397000001829002/Products"
-X PUT
-d @updaterelateddeal.json
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

CopiedZCRMRecord record = ZCRMRecord.getInstance("Leads", 1234567l);//module api name with record id
ZCRMJunctionRecord relatedRecord = ZCRMJunctionRecord.getInstance("Campaigns", 963258l);
relatedRecord.setRelatedData("Status", "active");
APIResponse response = record.addRelation(relatedRecord);
String recStatus = response.getStatus(); //check status of the update relation

Copiedtry{
$parentRecord=ZCRMRecord::getInstance("Products", 410405000001446001);
$junctionRecord=ZCRMJunctionRecord::getInstance("Price_Books",
410405000001404743);
$junctionRecord->setRelatedData("list_price", 140);
$responseIns=$parentRecord->addRelation($junctionRecord);
echo "HTTP Code:".$responseIns->getHttpStatusCode();
echo "Message:".$responseIns->getMessage();
echo "Code:".$responseIns->getCode();
echo "Details:".$responseIns->getDetails()['id'];
}catch (ZCRMException $e)
{
echo $e->getCode();
echo $e->getMessage();
}

Copieddef add_relation(self):
        try:
            record = ZCRMRecord.get_instance('Leads', 3719520000000323002)  # module API Name, entityId
            junction_record = ZCRMJunctionRecord.get_instance("Products",3719520000000450002)  # module API Name, entityId
            resp = record.add_relation(junction_record)
            print(resp.status_code)
            print(resp.code)
            print(resp.details)
            print(resp.message)
            print(resp.status)
        except ZCRMException as ex:
            print(ex.status_code)
            print(ex.error_message)
            print(ex.error_code)
            print(ex.error_details)
            print(ex.error_content)

CopiedSyntax:
zoho.crm.updateRelatedRecord(<module String>,<recordID Long>,<parentModuleName String>,<parentRecordId Long>,<dataMap Map>,<connectionName String>,<userAccess Boolean>);
mandatory : module,recordID,parentModuleName,parentRecordId,dataMap

Sample Request:
resp = zoho.crm.updateRelatedRecord("Related_List_Name_2","7000000037119","Leads","7000000037002", Map());

CopiedZCRMRecord recordIns = ZCRMRecord.GetInstance("Leads", 337216400000); //module api name with record id
ZCRMJunctionRecord relatedRecord = ZCRMJunctionRecord.GetInstance("Campaigns", 33721640000001); //RelatedList api name with RelatedList record id
relatedRecord.SetRelatedDetails("Status", "active");
APIResponse response = recordIns.AddRelation(relatedRecord);
String recStatus = response.Status; //check status of the update relation
//In the above example, lead with ID 337216400000 gets associated with the campaign with ID 33721640000001.

Request JSON keys

idstring, mandatory
Specify the unique ID of the related record that you want to associate. Refer to Get Records API to get the unique ID of the records.

Note

It is mandatory to send the sample data while adding relation between other modules.
To relate multiple records of a module to the parent module, you must pass individual JSON objects for each related record as shown in the example.
You can update a maximum of 100 related records per API call.

Sample Input

Copied{
	"data":[
		{
			"id":"3652397000000327001",
		},
		{
			"id":"3652397000001854001",
		}]
}

Copiedcurl "https://www.zohoapis.com/bigin/v1/Deals/3652397000001829002/Products"
-X PUT
-d @updaterelateddeal.json
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

CopiedZCRMRecord record = ZCRMRecord.getInstance("Leads", 1234567l);//module api name with record id
ZCRMJunctionRecord relatedRecord = ZCRMJunctionRecord.getInstance("Campaigns", 963258l);
relatedRecord.setRelatedData("Status", "active");
APIResponse response = record.addRelation(relatedRecord);
String recStatus = response.getStatus(); //check status of the update relation

Copiedtry{
$parentRecord=ZCRMRecord::getInstance("Products", 410405000001446001);
$junctionRecord=ZCRMJunctionRecord::getInstance("Price_Books",
410405000001404743);
$junctionRecord->setRelatedData("list_price", 140);
$responseIns=$parentRecord->addRelation($junctionRecord);
echo "HTTP Code:".$responseIns->getHttpStatusCode();
echo "Message:".$responseIns->getMessage();
echo "Code:".$responseIns->getCode();
echo "Details:".$responseIns->getDetails()['id'];
}catch (ZCRMException $e)
{
echo $e->getCode();
echo $e->getMessage();
}

Copieddef add_relation(self):
        try:
            record = ZCRMRecord.get_instance('Leads', 3719520000000323002)  # module API Name, entityId
            junction_record = ZCRMJunctionRecord.get_instance("Products",3719520000000450002)  # module API Name, entityId
            resp = record.add_relation(junction_record)
            print(resp.status_code)
            print(resp.code)
            print(resp.details)
            print(resp.message)
            print(resp.status)
        except ZCRMException as ex:
            print(ex.status_code)
            print(ex.error_message)
            print(ex.error_code)
            print(ex.error_details)
            print(ex.error_content)

CopiedSyntax:
zoho.crm.updateRelatedRecord(<module String>,<recordID Long>,<parentModuleName String>,<parentRecordId Long>,<dataMap Map>,<connectionName String>,<userAccess Boolean>);
mandatory : module,recordID,parentModuleName,parentRecordId,dataMap

Sample Request:
resp = zoho.crm.updateRelatedRecord("Related_List_Name_2","7000000037119","Leads","7000000037002", Map());

CopiedZCRMRecord recordIns = ZCRMRecord.GetInstance("Leads", 337216400000); //module api name with record id
ZCRMJunctionRecord relatedRecord = ZCRMJunctionRecord.GetInstance("Campaigns", 33721640000001); //RelatedList api name with RelatedList record id
relatedRecord.SetRelatedDetails("Status", "active");
APIResponse response = recordIns.AddRelation(relatedRecord);
String recStatus = response.Status; //check status of the update relation
//In the above example, lead with ID 337216400000 gets associated with the campaign with ID 33721640000001.

Possible Errors

INVALID_MODULEHTTP 400
The module name given seems to be invalid
Resolution: You have specified an invalid module name or there is no tab permission, or the module could have been removed from the available modules. Specify a valid module API name.
INVALID_MODULEHTTP 400
The given module is not supported in API
Resolution: The modules such as Documents and Projects are not supported in the current API. (This error will not be shown, once these modules are been supported). Specify a valid module API name.
INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above.
OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have ZohoCRM.modules.{module_name}.UPDATE scope. Create a new client with valid scope. Refer to scope section above.
NO_PERMISSIONHTTP 403
Permission denied to update records
Resolution: The user does not have permission to update related records data. Contact your system administrator.
INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in Server. Contact support team.
INVALID_REQUEST_METHODHTTP 400
The http request method type is not a valid one
Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above.
AUTHORIZATION_FAILEDHTTP 400
User does not have sufficient privilege to update related records data
Resolution: The user does not have the permission to update related records data. Contact your system administrator.
INVALID_DATAHTTP 400
the related id given seems to be invalid
Resolution: You have specified an incorrect related record ID. Please specify a valid record ID. Refer to Get Related Records API to get valid record IDs.
INVALID_DATAHTTP 202
invalid data
Resolution: The input specified is incorrect. Specify a valid input
MANDATORY_NOT_FOUNDHTTP 202
required field not found
Resolution: You have not specified one or more mandatory fields in the input. Refer to Fields Metadata API to know the mandatory fields.

Sample Response

Copied{
    "data": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "3652397000000327001"
            },
            "message": "relation added",
            "status": "success"
        },
        {
            "code": "SUCCESS",
            "details": {
                "id": "3652397000001854001"
            },
            "message": "relation added",
            "status": "success"
        }
    ]
}

Copiedcurl "https://www.zohoapis.com/bigin/v1/Deals/3652397000001829002/Products"
-X PUT
-d @updaterelateddeal.json
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

CopiedZCRMRecord record = ZCRMRecord.getInstance("Leads", 1234567l);//module api name with record id
ZCRMJunctionRecord relatedRecord = ZCRMJunctionRecord.getInstance("Campaigns", 963258l);
relatedRecord.setRelatedData("Status", "active");
APIResponse response = record.addRelation(relatedRecord);
String recStatus = response.getStatus(); //check status of the update relation

Copiedtry{
$parentRecord=ZCRMRecord::getInstance("Products", 410405000001446001);
$junctionRecord=ZCRMJunctionRecord::getInstance("Price_Books",
410405000001404743);
$junctionRecord->setRelatedData("list_price", 140);
$responseIns=$parentRecord->addRelation($junctionRecord);
echo "HTTP Code:".$responseIns->getHttpStatusCode();
echo "Message:".$responseIns->getMessage();
echo "Code:".$responseIns->getCode();
echo "Details:".$responseIns->getDetails()['id'];
}catch (ZCRMException $e)
{
echo $e->getCode();
echo $e->getMessage();
}

Copieddef add_relation(self):
        try:
            record = ZCRMRecord.get_instance('Leads', 3719520000000323002)  # module API Name, entityId
            junction_record = ZCRMJunctionRecord.get_instance("Products",3719520000000450002)  # module API Name, entityId
            resp = record.add_relation(junction_record)
            print(resp.status_code)
            print(resp.code)
            print(resp.details)
            print(resp.message)
            print(resp.status)
        except ZCRMException as ex:
            print(ex.status_code)
            print(ex.error_message)
            print(ex.error_code)
            print(ex.error_details)
            print(ex.error_content)

CopiedSyntax:
zoho.crm.updateRelatedRecord(<module String>,<recordID Long>,<parentModuleName String>,<parentRecordId Long>,<dataMap Map>,<connectionName String>,<userAccess Boolean>);
mandatory : module,recordID,parentModuleName,parentRecordId,dataMap

Sample Request:
resp = zoho.crm.updateRelatedRecord("Related_List_Name_2","7000000037119","Leads","7000000037002", Map());

CopiedZCRMRecord recordIns = ZCRMRecord.GetInstance("Leads", 337216400000); //module api name with record id
ZCRMJunctionRecord relatedRecord = ZCRMJunctionRecord.GetInstance("Campaigns", 33721640000001); //RelatedList api name with RelatedList record id
relatedRecord.SetRelatedDetails("Status", "active");
APIResponse response = recordIns.AddRelation(relatedRecord);
String recStatus = response.Status; //check status of the update relation
//In the above example, lead with ID 337216400000 gets associated with the campaign with ID 33721640000001.