User Groups Associations

Purpose

You can associate a user group with sharing rules, workflows, assignment rules, approval and review processes, and email notification criteria. Use this API to find out where a user group is associated.

Endpoints

Request Details

Request URL

{api-domain}/crm/{version}/settings/user_groups/{user_group_ID}/actions/associations

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.settings.user_groups.ALL/READ

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v6/settings/user_groups/3652397000012454002/actions/associations"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Response JSON

  • type

    Represents where the user group is associated. The possible values are data_sharing, workflow_rules, assignment_rules, approval_process, review_process, email_notification, calendar_bookings.

  • resource

    The name and ID of the rule that the user group is associated with.

  • details

    The API name of the module and its ID that the user group is associated to. For example, if the user group is a part of a data sharing rule for the Leads module, this object contains the API name and ID of Leads.

Possible Errors

  • NO_CONTENTHTTP 204

    There are no user groups in your org.
    Resolution: Create a user group to be able to view, update or delete.

  • INVALID_DATAHTTP 400

    The group ID is invalid.
    Resolution: Use the Get User Groups API to get the ID of the user group.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    You do not have the right scope to access this API.
    Resolution: Create a new token with ZohoCRM.settings.user_groups.ALL or ZohoCRM.settings.user_groups.GET scopes.

  • NO_PERMISSIONHTTP 403

    You do not have permission to view the groups.
    Resolution: You must have "Manage Groups" permission to view the groups. Contact your system administrator.

  • INTERNAL_SERVER_ERRORHTTP 500

    Unhandled and unexpected exception in server.
    Resolution: Contact support@zohocrm.com for assistance.

Sample Response

Copied{
    "associations": [
        {
            "resource": {
                "name": "lead sharing",
                "id": "3652397000012454068"
            },
            "details": {
                "module": {
                    "api_name": "Leads",
                    "id": "3652397000000002175"
                }
            },
            "type": "data_sharing"
        }
    ]
}