Create a Profile

Purpose

To create a profile in your Zoho CRM organization.

Endpoints

  • POST /settings/profiles/{clone_profile_ID}/actions/clone

Request Details

Request URL

{api-domain}/crm/{version}/settings/profiles/{clone_profile_ID}/actions/clone  
Where, clone-profile-id is the unique ID of the existing profile you want to clone. Use the Get Profiles API to get this ID.

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.settings.profiles.ALL
(or)
ZohoCRM.settings.profiles.CREATE

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/profiles/3652397000000026011/actions/clone"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@inputData.json"

Input JSON

  • namestring, mandatory

    The name of the new profile. Accepts up to 50 characters.

  • descriptionstring, optional

    A description of the profile. Accepts up to 250 characters.

Note

  • You can create one profile in a single API call.
  • By default, when you clone a profile (the parent profile specified in the Request URL), the newly created profile inherits the same access permissions in your Zoho CRM. However, to modify the access permissions for the new profile, you can use the Update Profile Permissions API.

Sample Input

Copied{
    "profiles": [
        {
            "name": "Sales Manager",
            "description": "Manages Sales for the TX region"
        }
    ]
}

Possible Errors

  • NO_PERMISSIONHTTP 403

    You do not have permission to create a profile
    Resolution: Contact your administrator to upgrade your permission.

  • DUPLICATE_DATAHTTP 404

    The profile you are trying to create already exists
    Resolution: The name of the profile is unique. Create a profile with a different name.

  • PROFILE_LIMIT_EXCEEDEDHTTP 404

    You can have a maximum of 25 profiles for your org
    Resolution: Delete unwanted profiles to create new ones within the maximum limit.

Sample Response

Copied{
    "profiles": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "3652397000009590009"
            },
            "message": "profile created successfully",
            "status": "success"
        }
    ]
}