Share files/folders with team API in Zoho WorkDrive

Share Files/Folders with Team

This API will share the file or folders with all team members in a team.

Endpoints

post https://www.zohoapis.com/workdrive/api/v1/permissions

Copy full URL

OAuth Scope

WorkDrive.files.sharing.CREATECopied!

curl --request POST \
  --url https://www.zohoapis.com/workdrive/api/v1/permissions \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/vnd.api+json' \
  --data '{"data":{"attributes":{"shared_type":"teammembers","role_id":"5","resource_id":"ly9zm0170fb40015f4e2297a144e2b68cfa68"},"type":"permissions"}}'

header = Map();
header.put("Accept","application/vnd.api+json");
data=Map();
data_param1=Map();
att_param1=Map();
att_param1.put("shared_type","teammembers");
att_param1.put("role_id","5");
att_param1.put("resource_id","ly9zm0170fb40015f4e2297a144e2b68cfa68");
data_param1.put("attributes",att_param1);
data_param1.put("type","permissions");
data.put("data",data_param1);
response = invokeurl
[
url : "https://www.zohoapis.com/workdrive/api/v1/permissions"
type : POST
parameters : data.toString()
headers : header
connection : "wdconnection"
];
info response;

Request Body

application/vnd.api+json

dataJSON Object(Required)

Hide Sub-Attributes

attributesJSON Object(Required)

Hide Sub-Attributes

shared_typestring(Required)

Should be "teammembers".

role_idinteger(Required)

Allowed role IDs for files:

34 - View
5 - Edit
4 - Share
6 - View and comment
33 - View and fill

Allowed role IDs for folders:

6 - View
5 - Edit
3 - Organize
7 - Upload

resource_idstring(Required)

The unique ID of the file/folder.

typestring(Required)

The JSON:API resource type. Always "permissions".

Allowed Values :

Show Values ▾

  {
    "data": {
      "attributes": {
        "shared_type": "teammembers",
        "role_id": "5",
        "resource_id": "ly9zm0170fb40015f4e2297a144e2b68cfa68"
      },
      "type": "permissions"
    }
  }

▼ Show full

  {
    "data": {
      "id": "cjrrrbba68351fce045a986ea712783c38fe6-ly9zmae16b43c258f458a9a57ac02c4f8d763",
      "type": "permissions",
      "attributes": {
        "shared_time_in_millis": 1618923194395,
        "shared_by": "Zylker Creation",
        "expiry_in_millis": 0,
        "relation_type": 0,
        "expiration_date": "",
        "share_to_entity_info": {},
        "share_to_member_type": 1,
        "role_id": 34,
        "shared_time_i18": "Apr 20, 6:23 PM",
        "shared_time": "Apr 20, 6:23 PM",
        "shared_status": "ACTIVE",
        "can_link_to_docs": true,
        "owner": "747937818",
        "allow_sharing_outside": false,
        "shared_type": "teammembers",
        "shared_to_entity": "Zylker Creation Limited",
        "delete_from_propagated_space": false,
        "message": "",
        "share_to": "ly9zmae16b43c258f458a9a57ac02c4f8d763",
        "is_expired": false,
        "shared_to_member_type": 1,
        "is_password_protected": false,
        "resource_id": "cjrrrbba68351fce045a986ea712783c38fe6",
        "permalink": "https://workdrive.zoho.com/file/cjrrrbba68351fce045a986ea712783c38fe6",
        "shared_by_zuid": "747938014"
      },
      "links": {
        "self": "https://www.zohoapis.com/workdrive/permissions/cjrrrbba68351fce045a986ea712783c38fe6-ly9zmae16b43c258f458a9a57ac02c4f8d763"
      }
    }
  }

  {
    "errors": [
      {
        "id": "R910",
        "title": "External User Email share is not allowed"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "R012",
        "title": "Resource is not in active status to process this action"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "R914",
        "title": "External User Email share is allowed only for white listed domains and users"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "R208",
        "title": "Can not share libraries to user"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "R913",
        "title": "Anyone on internet and publish share are not allowed"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "R955",
        "title": "Sharing resource outside org with share permission is restricted."
      }
    ]
  }

  {
    "errors": [
      {
        "id": "R952",
        "title": "User doesn't provide permission for sharing to outside org user."
      }
    ]
  }

  {
    "errors": [
      {
        "id": "R974",
        "title": "External Sharing has been restricted via DLP Classification label\""
      }
    ]
  }

  {
    "errors": [
      {
        "id": "R953",
        "title": "User doesn't provide permission for sharing to non zoho user."
      }
    ]
  }

  {
    "errors": [
      {
        "id": "R950",
        "title": "Insufficient permission to share to yourself"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "R214",
        "title": "Unknown shareTo zuid / emailid"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "R973",
        "title": "Warn on External Sharing has been enforced via DLP Classification label to external user"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "R971",
        "title": "Warn on External Sharing has been enforced via DLP Classification label to non zoho user"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "R905",
        "title": "External share is not allowed"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "R708",
        "title": "Group with mentioned id not available"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "R956",
        "title": "Recieving resource from outside is restricted for Share_to user Org"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "R253",
        "title": "Client user cannot perform any action on another client user"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "R260",
        "title": "Cross org share limit exceeded"
      }
    ]
  }

▼ Show full