updateRelatedRecords Method - Comparison

updateRelatedRecords Method - Comparison

Purpose

To update records related to another record.

Request URL

Version 1.0:

https://crm.zoho.com/crm/private/xml/Campaigns/updateRelatedRecords?authtoken=AuthToken&scope=crmapi&relatedModule=Contacts&xmlData=<Contacts><row no="1"><FLval="CONTACTID">9999999999</FL><FLval="member_status">Sent</FL></row></Contacts>&id=99999999999

Version 2.0:

URL: https://www.zohoapis.com/crm/v2/{module_api_name}/{record_id}/{relatedlist_api_name}/{related_record_id}

Method: GET

Request body: The content of a record given in JSON format.

Header: Authorization=Zoho-oauthtoken {oauth_token}

For Example : https://www.zohoapis.com/crm/v2/Campaigns/1386586000000803001/Contacts/138658600000059902

Note:

  • The API names of the related lists can be found using this API(GET) - https://www.zohoapis.com/crm/v2/settings/related_lists?module=Campaigns

Request Parameters

Version 1.0 Version 2.0
authtoken=**** Authorization=Zoho-oauthtoken ***** - as a Header.
scope=crmapi N/A
relatedModule Given within the Request URL.
id Given within the Request URL.
XmlData
Ex. xmlData=<Contacts><row no="1"><FLval="CONTACTID">1386586000000599023</FL><FLval="member_status">Sent</FL></row></Contacts>&id=1386586000000803001		 N/A
Required data has to be given in request body.
{
  "data": [
   {
    "Member_Status":"Sent"
   }
  ]
}

Sample Responses:

Response in Version 1.0 Response in Version 2.0
<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/crm/private/xml/Campaigns/updateRelatedRecords">
<result>
<status>
<code>200</code>
</status>
<success>
<code>4800</code>
</success>
<addedids>[1386586000001867241]</added-ids>
</result>
</response>		 {
  "data": [
   {
     "code": "SUCCESS",
     "details": {
      "id": "1386586000002576001"
     },
     "message": "relation added",
     "status": "success"
   }
  ]
 }

    • Related Articles

    • updateRelatedRecords Method

      Table of Contents Purpose Modules Supported Request URL Request Parameters Examples Purpose You can use the updateRelatedRecords method to update records related to another record. Modules Supported Module Related Module Campaigns Leads Contacts ...

    • downloadPhoto Method - Comparison

      Purpose To download the photo of a lead or a contact. Request URL Version 1.0: https://crm.zoho.com/crm/private/xml/(Leads or Contacts)/downloadPhoto?authtoken=AuthToken&scope=crmapi&id=RecordID Version 2.0: URL: ...

    • downloadFile Method - Comparison

      Purpose To download a file attached to a record. Request URL Version 1.0: https://crm.zoho.com/crm/private/xml/Leads/downloadFile?authtoken=AuthToken&scope=crmapi&id=Attachment Id Version 2.0: URL: ...

    • deletePhoto Method - Comparison

      Purpose To delete a photo of a contact or lead. Request URL Version 1.0: https://crm.zoho.com/crm/private/xml/(Leads or Contacts)/deletePhoto?authtoken=AuthToken&scope=crmapi&id=RecordID Version 2.0: URL: https://www.zohoapis.com/crm/v2/{Leads or ...

    • deleteRecords Method - Comparison

      Purpose To delete the selected records. Request URL Version 1.0: https://crm.zoho.com/crm/private/xml/Leads/deleteRecords?authtoken=AuthToken&scope=crmapi&id=Record ID Version 2.0: URL: https://www.zohoapis.com/crm/v2/Leads/{record_id} Method: DELETE ...