Invite New Member to Team
This API is used to invite one or more new members to a team in WorkDrive.
Note:
Only Team Admins and the Super Admin can invite new members to a team.
Endpoints
post https://www.zohoapis.com/workdrive/api/v1/users
Copy full URL
OAuth Scope
WorkDrive.users.CREATECopied!
curl --request POST \
--url https://www.zohoapis.com/workdrive/api/v1/users \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'content-type: application/vnd.api+json' \
--data '{"data":{"attributes":{"email_id":"reyansh.ahuja@zylker.com","category_id":"ly9zmae16b43c258f458a9a57ac02c4f8d763","role_id":"30"},"type":"users"}}'Request Body
application/vnd.api+jsondataJSON Object(Required)
Hide Sub-Attributes
attributesJSON Object(Required)
Hide Sub-Attributes
email_idstring(Required)
The valid email addresses of the users to whom the invites will be sent.
category_idstring(Required)
The unique ID of the team.
role_idinteger(Required)
Allowed values for role id:
- 30 - Team Member
- 31 - Team Admin
- 32 - Super Admin
typestring(Required)
The JSON:API resource type. Always "users".
Allowed Values :
Show Values ▾
usersCopied!
Copy all as JSON Array
{
"data": {
"attributes": {
"email_id": "reyansh.ahuja@zylker.com",
"category_id": "ly9zmae16b43c258f458a9a57ac02c4f8d763",
"role_id": "30"
},
"type": "users"
}
}
{
"data": [
{
"id": "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012",
"type": "users",
"attributes": {
"member_type": 1,
"theme_color": "28B294",
"getting_started": 0,
"is_org_template_admin": false,
"favoritedfiles_view_pref": {
"sort_by": "last_modified",
"sort_order": "desc",
"filtered_by": "all",
"layout": "list"
},
"default_view_type": 2,
"view_pref": {
"sort_by": "last_modified",
"sort_order": "desc",
"layout": "list"
},
"edition": "TEAM",
"unread_count_myspace": 0,
"mig_status": 0,
"last_login_time_in_millisecond": 0,
"files_view_pref": {
"sort_by": "last_modified",
"sort_order": "desc",
"filtered_by": "all",
"layout": "list"
},
"invited_time": 1618249438092,
"user_type": 0,
"labeledfiles_view_pref": {
"sort_by": "last_modified",
"sort_order": "desc",
"filtered_by": "all",
"layout": "list"
},
"role_id": 30,
"is_sync_enabled": true,
"has_myfolder": true,
"last_accessed_library": "",
"is_mobile_enabled": true,
"last_accessed_folder": "",
"enable_myspace_restriction_all": false,
"connected_devices": 0,
"outgoingfiles_view_pref": {
"sort_by": "last_modified",
"sort_order": "desc",
"filtered_by": "all",
"layout": "list"
},
"capabilities": {
"can_access_myfolder": true,
"can_have_org_templates": true,
"can_sync": true,
"can_create_team": true
},
"incomingfiles_view_pref": {
"sort_by": "shared_time",
"sort_order": "desc",
"filtered_by": "all",
"layout": "list"
},
"app_names": [],
"display_name": "Zylker Creation",
"zuid": "747938058",
"trashedfiles_view_pref": {
"sort_by": "last_modified",
"sort_order": "desc",
"filtered_by": "all",
"layout": "list"
},
"reinvite": false,
"avatar_url": "https://contacts.zoho.com/file?t=user&ID=747938058&fs=thumb&nps=404",
"allowed_myspace_storage": -1,
"is_unread_myspace": false,
"invited_time_i18": "Apr 12, 11:13 PM",
"zid_type": 262144,
"status": "INVITED"
},
"relationships": {
"privatespace": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/privatespace",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/privatespace"
}
},
"teams": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/teams",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/teams"
}
},
"devices": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/devices",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/devices"
}
},
"records": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/records",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/records"
}
},
"enterprise": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/enterprise",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/enterprise"
}
},
"incomingfiles": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/incomingfiles",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/incomingfiles"
}
},
"libraries": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/libraries",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/libraries"
}
},
"favoritedfiles": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/favoritedfiles",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/favoritedfiles"
}
},
"groups": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/groups",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/groups"
}
},
"labels": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/labels",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/labels"
}
},
"recentfiles": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/recentfiles",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/recentfiles"
}
},
"license": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/license",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/license"
}
},
"recordsuggestions": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/recordsuggestions",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/recordsuggestions"
}
},
"organization": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/organization",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/organization"
}
},
"collaborators": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/collaborators",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/collaborators"
}
},
"labeledfiles": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/labeledfiles",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/labeledfiles"
}
},
"incomingfolders": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/incomingfolders",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/incomingfolders"
}
},
"workspaces": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/workspaces",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/workspaces"
}
},
"unreadfiles": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/unreadfiles",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/unreadfiles"
}
},
"tasks": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/tasks",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/tasks"
}
},
"notifications": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/notifications",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/notifications"
}
},
"contacts": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/contacts",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/contacts"
}
},
"apps": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/relationships/apps",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012/apps"
}
}
},
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002012"
}
},
{
"id": "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013",
"type": "users",
"attributes": {
"member_type": 1,
"theme_color": "28B294",
"getting_started": 0,
"is_org_template_admin": false,
"favoritedfiles_view_pref": {
"sort_by": "last_modified",
"sort_order": "desc",
"filtered_by": "all",
"layout": "list"
},
"default_view_type": 2,
"view_pref": {
"sort_by": "last_modified",
"sort_order": "desc",
"layout": "list"
},
"edition": "TEAM",
"unread_count_myspace": 0,
"mig_status": 0,
"last_login_time_in_millisecond": 0,
"files_view_pref": {
"sort_by": "last_modified",
"sort_order": "desc",
"filtered_by": "all",
"layout": "list"
},
"invited_time": 1618249438093,
"user_type": 0,
"labeledfiles_view_pref": {
"sort_by": "last_modified",
"sort_order": "desc",
"filtered_by": "all",
"layout": "list"
},
"role_id": 30,
"is_sync_enabled": true,
"has_myfolder": true,
"last_accessed_library": "",
"is_mobile_enabled": true,
"last_accessed_folder": "",
"enable_myspace_restriction_all": false,
"connected_devices": 0,
"outgoingfiles_view_pref": {
"sort_by": "last_modified",
"sort_order": "desc",
"filtered_by": "all",
"layout": "list"
},
"capabilities": {
"can_access_myfolder": true,
"can_have_org_templates": true,
"can_sync": true,
"can_create_team": true
},
"incomingfiles_view_pref": {
"sort_by": "shared_time",
"sort_order": "desc",
"filtered_by": "all",
"layout": "list"
},
"app_names": [],
"display_name": "Zylker Creation",
"zuid": "747938123",
"trashedfiles_view_pref": {
"sort_by": "last_modified",
"sort_order": "desc",
"filtered_by": "all",
"layout": "list"
},
"reinvite": false,
"avatar_url": "https://contacts.zoho.com/file?t=user&ID=747938123&fs=thumb&nps=404",
"allowed_myspace_storage": -1,
"is_unread_myspace": false,
"invited_time_i18": "Apr 12, 11:13 PM",
"zid_type": 262144,
"status": "INVITED"
},
"relationships": {
"privatespace": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/privatespace",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/privatespace"
}
},
"teams": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/teams",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/teams"
}
},
"devices": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/devices",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/devices"
}
},
"records": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/records",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/records"
}
},
"enterprise": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/enterprise",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/enterprise"
}
},
"incomingfiles": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/incomingfiles",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/incomingfiles"
}
},
"libraries": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/libraries",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/libraries"
}
},
"favoritedfiles": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/favoritedfiles",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/favoritedfiles"
}
},
"groups": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/groups",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/groups"
}
},
"labels": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/labels",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/labels"
}
},
"recentfiles": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/recentfiles",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/recentfiles"
}
},
"license": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/license",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/license"
}
},
"recordsuggestions": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/recordsuggestions",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/recordsuggestions"
}
},
"organization": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/organization",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/organization"
}
},
"collaborators": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/collaborators",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/collaborators"
}
},
"labeledfiles": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/labeledfiles",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/labeledfiles"
}
},
"incomingfolders": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/incomingfolders",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/incomingfolders"
}
},
"workspaces": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/workspaces",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/workspaces"
}
},
"unreadfiles": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/unreadfiles",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/unreadfiles"
}
},
"tasks": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/tasks",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/tasks"
}
},
"notifications": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/notifications",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/notifications"
}
},
"contacts": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/contacts",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/contacts"
}
},
"apps": {
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/relationships/apps",
"related": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013/apps"
}
}
},
"links": {
"self": "https://workdriveinteg.zoho.com/users/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002013"
}
}
]
}
{
"errors": [
{
"id": "E004",
"title": "Invalid invitation details"
}
]
}
{
"errors": [
{
"id": "R008",
"title": "Unauthorized access"
}
]
}
{
"errors": [
{
"id": "E005",
"title": "Invalid user edition details"
}
]
}
{
"errors": [
{
"id": "T017",
"title": "Maximum one member should be a super admin"
}
]
}
{
"errors": [
{
"id": "T026",
"title": "Daily users invite limit exhausted"
}
]
}
{
"errors": [
{
"id": "L001",
"title": "No of users specified in License exceeded"
}
]
}
{
"errors": [
{
"id": "F000",
"title": "General exception"
}
]
}
{
"errors": [
{
"id": "U056",
"title": "User's with admin and super admin role can't be of Guest type user"
}
]
}
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.