Transfer Users and Delete a Profile

Purpose

To transfer the users to a new profile and delete the old one.

Endpoints

DELETE /settings/profiles/{profile-id}?transfer_to={existing_profile_id}

Request Details

Request URL

{api-domain}/crm/{version}/settings/profiles/{profile-id}?transfer_to={existing_profile_id}
Where, profile-id is the unique ID of the profile you want to delete.
existing_profile_id is the unique ID of the existing profile you want to transfer the users to.

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.settings.profiles.ALL
(or)
scope=ZohoCRM.settings.profiles.DELETE

Parameters

transfer_tonumber, mandatory
The unique ID of the profile you want to transfer the records of the old profile to.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v5/settings/profiles/3652397000009592005?transfer_to=3652397000000026011"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Possible Errors

REQUIRED_PARAM_MISSINGHTTP 400
You have not included the transfer_to parameter.
Resolution: The transfer_to parameter is mandatory to transfer the users to the new profile and delete the old one. Use the Get Profiles API to get the ID of the profile you want to transfer the users to.
INVALID_DATAHTTP 400
The profile ID is either incorrect or deleted already.
Resolution: Specify a valid profile ID. Use the Get Profiles API to get the ID of the profile you want to transfer the users to.

Sample Response

Copied{
    "code": "SUCCESS",
    "details": {},
    "message": "Profile deleted",
    "status": "success"
}