Update records

Update the existing records or a specific record. The records include contacts, pipelines, companies, products, events, calls, and so on.

Endpoints

PUT /{module_api_name}

PUT /{module_api_name}/{record_id}

Request URL

For existing records, use

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

For a specific record, use

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

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 module in which you want to update the records. The possible modules include contacts, accounts (companies in Bigin), products, calls, events, and tasks.

Notes:

If the length of a field value exceeds the specified maximum length, an error will occur.
If you are using the API inside a Function and the length of a field value exceeds the limit, the Function will receive an error response from the API. For example, if the maximum length for a "Text field" is defined as 10, providing a value like "12345678901" with 11 characters will result an error.
The API performs duplicate checks for every update record API call based on unique fields. Make sure that you avoid duplicating records by providing unique values for the designated fields.
A maximum of 100 records can be updated per API call.
Use only the Field API names in the input. To obtain the Field API names, you can make use of the Fields metadata API. Look for the value corresponding to the key api_name for each field.
The $approved key is used to enable approval mode for records. This is primarily for records fetched from webforms.
The trigger input for the API is "workflow". If you do not specify a trigger value, the workflows associated with the API will be executed. To prevent the execution of workflows, provide the trigger value as an empty array, i.e., [ ].

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
Tasks	Tasks
Events	Events
Calls	Calls

record_id stringOptional

The unique identification of a record in a module. Use this when you want to update a specific record in a module. You can get the record ID from the Get records API.

Body parameters

id stringRequired

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

Sample request

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

Copiedupdate_pipelines = Map();

Sample response body

Copied//Consider the following data is saved in a file 'updatepipeline.json'
{
    "data": [
        {
            "id": "2034020000000489124",
            "Amount": 8000,
            "Stage": "Qualification"
        },
        {
            "id": "2034020000000489080",
            "Contact_Name": {
                "id": "2034020000000489022"
            }
        },
        {
            "id": "2034020000000478412",
            "Amount": 10000
        },
        {
            "id": "2034020000000478276",
            "Tag": [
                {
                    "name": "Adventure"
                }
            ]
        }
    ]
}

Copiedupdate_pipelines = Map();

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.

Sample response

Copied{
    "data": [
        {
            "code": "SUCCESS",
            "details": {
                "Modified_Time": "2023-07-11T12:47:57+05:30",
                "Modified_By": {
                    "name": "Zylker Travels",
                    "id": "2034020000000457001"
                },
                "Created_Time": "2023-04-21T12:09:26+05:30",
                "id": "2034020000000489124",
                "Created_By": {
                    "name": "Zylker Travels",
                    "id": "2034020000000457001"
                }
            },
            "message": "record updated",
            "status": "success"
        },
        {
            "code": "SUCCESS",
            "details": {
                "Modified_Time": "2023-07-11T12:47:57+05:30",
                "Modified_By": {
                    "name": "Zylker Travels",
                    "id": "2034020000000457001"
                },
                "Created_Time": "2023-04-21T11:28:32+05:30",
                "id": "2034020000000489080",
                "Created_By": {
                    "name": "Zylker Travels",
                    "id": "2034020000000457001"
                }
            },
            "message": "record updated",
            "status": "success"
        },
        {
            "code": "SUCCESS",
            "details": {
                "Modified_Time": "2023-07-11T12:47:57+05:30",
                "Modified_By": {
                    "name": "Zylker Travels",
                    "id": "2034020000000457001"
                },
                "Created_Time": "2023-04-19T16:23:38+05:30",
                "id": "2034020000000478412",
                "Created_By": {
                    "name": "Zylker Travels",
                    "id": "2034020000000457001"
                }
            },
            "message": "record updated",
            "status": "success"
        },
        {
            "code": "SUCCESS",
            "details": {
                "Modified_Time": "2023-07-11T12:47:57+05:30",
                "Modified_By": {
                    "name": "Zylker Travels",
                    "id": "2034020000000457001"
                },
                "Created_Time": "2023-04-19T15:54:21+05:30",
                "id": "2034020000000478276",
                "Created_By": {
                    "name": "Zylker Travels",
                    "id": "2034020000000457001"
                }
            },
            "message": "record updated",
            "status": "success"
        }
    ]
}