Add members to team folder API in Zoho WorkDrive

Team Folder Members

Team Folders allows its members to create, upload, edit, and share files and folders to collaborate effectively on complex projects.

The members of the Team Folder are given roles with specific access permissions that help in facilitate a better understanding of what each member can do when work is assigned to them.

Download Team Folder Members OpenAPI Document

Download

Add Members To Team Folder

This API adds already existing team members in a team to the team folder.

Endpoints

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

Copy full URL

OAuth Scope

WorkDrive.teamfolders.sharing.CREATECopied!

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

header = Map();
header.put("Accept","application/vnd.api+json");
data=Map();
data_param1=Map();
att_param1=Map();
att_param1.put("email_id","reyansh.ahuja@zylker.com");
att_param1.put("shared_type","workspace");
att_param1.put("role_id","5");
att_param1.put("resource_id","ly9zm0170fb40015f4e2297a144e2b68cfa68");
data_param1.put("attributes",att_param1);
data_param1.put("type","members");
data.put("data",data_param1);
response = invokeurl
[
url : "https://www.zohoapis.com/workdrive/api/v1/members"
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

email_idstring(Required)

The email of the user who will be added to the team folder.

shared_typestring(Required)

Allowed value: "workspace".

role_idinteger(Required)

The ID that represent the role given to the member in the team folder:

1- Admin
2 - Organizer
5 - Editor
6 - Commenter
34 - Viewer

resource_idstring(Required)

The unique ID of a team folder.

typestring(Required)

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

Allowed Values :

Show Values ▾

  {
    "data": {
      "attributes": {
        "email_id": "reyansh.ahuja@zylker.com",
        "shared_type": "workspace",
        "role_id": "5",
        "resource_id": "ly9zm0170fb40015f4e2297a144e2b68cfa68"
      },
      "type": "members"
    }
  }

▼ Show full

  {
    "data": [
      {
        "id": "ly9zm0170fb40015f4e2297a144e2b68cfa68-747938058",
        "type": "members",
        "attributes": {
          "email_id": "reyansh.ahuja@zylker.com",
          "shared_time_in_millis": 1618252163531,
          "shared_by": "Zylker Creation",
          "expiry_in_millis": 0,
          "relation_type": 0,
          "expiration_date": "Jan 1, 1970, 5:30 AM",
          "share_to_entity_info": {
            "display_name": "Zylker Creation",
            "email_id": "reyansh.ahuja@zylker.com",
            "avatar_url": "https://contacts.zoho.com/file?t=user&ID=747938058&fs=thumb&nps=404"
          },
          "share_to_member_type": 1,
          "role_id": 5,
          "shared_time_i18": "Apr 12, 11:59 PM",
          "shared_time": "Apr 12, 11:59 PM",
          "shared_status": "INACTIVE",
          "can_link_to_docs": true,
          "owner": "747937818",
          "allow_sharing_outside": false,
          "shared_type": "workspace",
          "delete_from_propagated_space": false,
          "display_name": "Zylker Creation",
          "message": "",
          "share_to": "747938058",
          "is_expired": false,
          "shared_to_member_type": 1,
          "avatar_url": "https://contacts.zoho.com/file?t=user&ID=747938058&fs=thumb&nps=404",
          "is_password_protected": false,
          "resource_id": "ly9zm0170fb40015f4e2297a144e2b68cfa68",
          "permalink": "https://www.zohoapis.com/workdrive/file/ly9zm0170fb40015f4e2297a144e2b68cfa68",
          "shared_by_zuid": "747938014"
        },
        "links": {
          "self": "https://www.zohoapis.com/workdrive/members/ly9zm0170fb40015f4e2297a144e2b68cfa68-747938058"
        }
      }
    ]
  }

  {
    "errors": [
      {
        "id": "R215",
        "title": "Resource owned by user or already shared to user"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "R004",
        "title": "Invalid resourceId passed. Please use a valid resourceId"
      }
    ]
  }

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

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

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

  {
    "errors": [
      {
        "id": "R219",
        "title": "Invalid space id"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "I001",
        "title": "App details not available"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "I045",
        "title": "Workspace is not associated with app"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "R707",
        "title": "Cannot share Resource to the group of another team"
      }
    ]
  }

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

  {
    "errors": [
      {
        "id": "I007",
        "title": "Unauthorized App"
      }
    ]
  }

▼ Show full