Change record owner

Change the owner of a record in a module.

Endpoints

POST /{module_api_name}/{record_id}/actions/change_owner

Request URL

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

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.change_owner.CREATE

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 stringRequired

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

Body parameters

owner jsonobjectRequired

The JSON object represents the owner to which the record will be assigned. It contains the following properties:

id jsonobjectRequired

The unique identifier (owner id) of the owner. You can get the owner IDs from the Get users data API.

notify booleanOptional

By setting true or false, you can allow or restrict the email notification to be sent to the new owner when the record is assigned to them.

Sample request

Curl Deluge

Copiedcurl "https://www.zohoapis.com/bigin/v2/Pipelines/2034020000000489124/actions/change_owner" \
-X POST \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf" \
-d "@newowner.json"

Copiednew_owner = Map();
new_owner.put("id", "Important");
new_owner.put("notify", "true");

owner_info = List();
owner_info.add(new_owner);

params = Map();
params.put("owner_info", owner_info);

response = invokeurl
[
	url :"https://www.zohoapis.com/bigin/v2/contacts/actions/change_owner"
	type :POST
	parameters: params.toString()
	connection:"connection_link_name"
];
info response;

Sample request body

Copied{
  "owner": {
    "id": "1908973000000463004"
  },
  "notify": true
}

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.

Sample response

Copied{
    "data": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "1908973000000470002"
            },
            "message": "owner is successfully updated",
            "status": "success"
        }
    ]
}