Update related list records

Update relation between the records.

Endpoints

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

Request URL

{api-domain}/bigin/v2/{module_api_name}/{record_id}/{related_list_api_name}

Choose domain-specific URL to replace {api-domain}

You can use the domain-specific URL to access Bigin resources. Based on the data center in which the Bigin account's resources are available, replace {api-domain} in the preceding request with one of the following API domain URLs:

For US, https://www.zohoapis.com
For EU, https://www.zohoapis.eu
For AU, https://www.zohoapis.com.au
For IN, https://www.zohoapis.in
For CN, https://www.zohoapis.com.cn
For JP, https://www.zohoapis.jp

For more information, see Multi DC Support.

Authorization

For this endpoint, pass the access token as an authorization header. See OAuth Authentication for more information about access tokens.

Authorization: Zoho-oauthtoken <ACCESS_TOKEN>

You must authenticate using an access token that is associated with one of the following scopes:

ZohoBigin.modules.ALL
ZohoBigin.modules.{module_name}.ALL
ZohoBigin.modules.{module_name}.WRITE
ZohoBigin.modules.{module_name}.UPDATE

In the above scope, replace {module_name} with the necessary. The possible modules include pipelines, contacts, accounts (companies in Bigin), and products.

Request parameters

The available request parameters are given below:

Path parameters

module_api_name stringRequired

The API name of the module. The possible modules for this endpoint and their API name are given below:

Module	API Name
Contacts	Contacts
Pipelines	Pipelines
Companies	Accounts
Products	Products

record_id stringRequired

The unique identification of a record in a module. You can get the record ID from the Get records API.

related_list_api_name stringRequired

The API name of the related list. The supported related lists for the specified module can be obtained from Get related lists metadata API.

Body parameters

id stringRequired

The unique identification of a related list record. You can get the record ID from the Get records API.

Notes:

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 request

Copiedcurl "https://www.zohoapis.com/bigin/v2/Pipelines/2034020000000644063/Products" \
-X PUT \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf" \
-d "@updaterelateddeal.json"

Sample request body

Copied//Consider the following data is saved in a file 'updaterelateddeal.json'
{
    "data": [
        {
            "id": "2034020000000489203",
            "Unit_Price": 6000
        },
        {
            "id": "2034020000000489200",
            "Product_Code": "AFR001"
        }
    ]
}

Response object

The response object provides information regarding the success message or status.

Possible error codes

The response of this resource includes HTTP status and error codes.

The most common HTTP error codes that occur when you request access to this endpoint are given in the following:

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": "2034020000000489203"
            },
            "message": "relation updated",
            "status": "success"
        },
        {
            "code": "SUCCESS",
            "details": {
                "id": "2034020000000489200"
            },
            "message": "relation updated",
            "status": "success"
        }
    ]
}

Sample request body

Copied//Consider the following data is saved in a file 'updaterelateddeal.json'
{
    "data": [
        {
            "id": "2034020000000489203",
            "Unit_Price": 6000
        },
        {
            "id": "2034020000000489200",
            "Product_Code": "AFR001"
        }
    ]
}