Members (Sharing) API

Manage who can access presentations. Add members, list current access, change a member's role, or revoke access permissions.

Data Center:

⬇ Download OpenAPI Spec

GET List Shared Members

GET https://show.zoho.com/api/v1/presentation/{rid}/members

Required Scopes:

ZohoShow.showdocslist.READ

Returns the access list for a presentation, including every user and group that has been shared with and the owner.

Path parameters

Name	Type	Required	Description
rid	string	Required	Resource id of the presentation. The caller must have the appropriate permission on this presentation.

Query parameters

Name	Type	Required	Description
fields	string	Optional	Comma-separated response fields to include. Allowed values: user_id, email, display_name, role, added_time, permission.

Samples

Responses

200 Shared Members Retrieved

200 Field Specific Response

200 No permission to trash

400 Document belongs to another user

500 Presentation already in trash

{
  "data": {
    "shared_users": [
      {
        "encrypted_user_id": "35ba91a9d8cb643320db79782a19d131",
        "primary_email": "user@example.com",
        "role": "VIEWER",
        "display_name": "Sample User",
        "user_id": "93703623"
      },
      {
        "encrypted_user_id": "df37321cb4d4723d20725cf6a8bd04c8",
        "primary_email": "user@example.com",
        "role": "COOWNER",
        "user_type": 3,
        "display_name": "Sample User",
        "user_id": "93600994"
      }
    ]
  },
  "message": "Shared users retrieved",
  "request_uri": "/api/v1/presentation/7fgg637ac6060b3f24b368cafcbd2652f292c/members",
  "status": "success"
}

Code Examples

cURL

curl -X GET "https://show.zoho.com/api/v1/presentation/{rid}/members?fields=user_id,email,display_name" \
  -H "Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

JavaScript

const response = await fetch('https://show.zoho.com/api/v1/presentation/{rid}/members?fields=user_id,email,display_name', {
  method: 'GET',
  headers: {
    'Authorization': 'Zoho-oauthtoken YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
// Process the response data
return data;

Node.js

const https = require('https');
const url = require('url');

const options = {
  ...url.parse('https://show.zoho.com/api/v1/presentation/{rid}/members?fields=user_id,email,display_name'),
  method: 'GET',
  headers: {
    'Authorization': 'Zoho-oauthtoken YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => data += chunk);
  res.on('end', () => {
    const result = JSON.parse(data);
    // Process the response data
  });
});

req.end();

Python

import requests

url = "https://show.zoho.com/api/v1/presentation/{rid}/members?fields=user_id,email,display_name"
headers = {
    "Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
data = response.json()
print(data)

Java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import java.time.Duration;

public class ApiClient {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newBuilder()
            .connectTimeout(Duration.ofSeconds(10))
            .build();

        HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
            .uri(URI.create("https://show.zoho.com/api/v1/presentation/{rid}/members?fields=user_id,email,display_name"))
            .header("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN")
            .timeout(Duration.ofSeconds(30));

            .header("Content-Type", "application/json")
        HttpRequest request = requestBuilder
            .GET(HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = client.send(request,
            HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

Deluge

info "Making API request to: https://show.zoho.com/api/v1/presentation/{rid}/members?fields=user_id,email,display_name";

headers = Map();
headers.put("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN");
headers.put("Content-Type", "application/json");

response = invokeurl
[
    url: "https://show.zoho.com/api/v1/presentation/{rid}/members?fields=user_id,email,display_name"
    type: GET
    headers: headers
];

if (response.get("status_code") == 200) {
    info "Request successful";
    responseData = response.get("response");
    info responseData;
} else {
    info "Request failed with status: " + response.get("status_code");
    info response.get("response");
}

POST Share Presentation (Add Members)

POST https://show.zoho.com/api/v1/presentation/{rid}/members

Required Scopes:

ZohoShow.showdocslist.UPDATE

Grants roles on a presentation to users by email id. Supports VIEWER, COMMENTOR, COLLABORATOR, and COOWNER roles.

Path parameters

Name	Type	Required	Description
rid	string	Required	Resource id of the presentation. The caller must have the appropriate permission on this presentation.

Samples

Request Body

JSON

{
  "email_ids": "{{email_ids}}",
  "role": "VIEWER",
  "allow_sharing_outside": "true"
}

Responses

200 Members added

500 Not authorized to share

200 Presentation already shared

400 Document belongs to another user

500 Presentation already in trash

{
  "data": {
    "result": {
      "viewer": [
        "66968086"
      ]
    },
    "status": true
  },
  "message": "Presentation members shared",
  "request_uri": "/api/v1/presentation/cpnv3d0203ec89cba4207ba255d785dfe125c/members",
  "status": "success"
}

Code Examples

cURL

curl -X POST "https://show.zoho.com/api/v1/presentation/{rid}/members" \
  -H "Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "email_ids": "{{email_ids}}",
  "role": "VIEWER",
  "allow_sharing_outside": "true"
}'

JavaScript

const response = await fetch('https://show.zoho.com/api/v1/presentation/{rid}/members', {
  method: 'POST',
  headers: {
    'Authorization': 'Zoho-oauthtoken YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "email_ids": "{{email_ids}}",
  "role": "VIEWER",
  "allow_sharing_outside": "true"
})
});

const data = await response.json();
// Process the response data
return data;

Node.js

const https = require('https');
const url = require('url');

const options = {
  ...url.parse('https://show.zoho.com/api/v1/presentation/{rid}/members'),
  method: 'POST',
  headers: {
    'Authorization': 'Zoho-oauthtoken YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => data += chunk);
  res.on('end', () => {
    const result = JSON.parse(data);
    // Process the response data
  });
});

req.write(JSON.stringify({
  "email_ids": "{{email_ids}}",
  "role": "VIEWER",
  "allow_sharing_outside": "true"
}));
req.end();

Python

import requests

url = "https://show.zoho.com/api/v1/presentation/{rid}/members"
headers = {
    "Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
}

data = {
  "email_ids": "{{email_ids}}",
  "role": "VIEWER",
  "allow_sharing_outside": "true"
}

response = requests.post(url, headers=headers, json=data)
data = response.json()
print(data)

Java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import java.time.Duration;

public class ApiClient {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newBuilder()
            .connectTimeout(Duration.ofSeconds(10))
            .build();

        HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
            .uri(URI.create("https://show.zoho.com/api/v1/presentation/{rid}/members"))
            .header("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN")
            .timeout(Duration.ofSeconds(30));

            .header("Content-Type", "application/json")
        String requestBody = "{\"email_ids\":\"{{email_ids}}\",\"role\":\"VIEWER\",\"allow_sharing_outside\":\"true\"}";
        HttpRequest request = requestBuilder
            .POST(HttpRequest.BodyPublishers.ofString(requestBody))
            .build();

        HttpResponse<String> response = client.send(request,
            HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

Deluge

info "Making API request to: https://show.zoho.com/api/v1/presentation/{rid}/members";

headers = Map();
headers.put("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN");
headers.put("Content-Type", "application/json");

requestData = {"email_ids": "{{email_ids}}", "role": "VIEWER", "allow_sharing_outside": "true"};

response = invokeurl
[
    url: "https://show.zoho.com/api/v1/presentation/{rid}/members"
    type: POST
    headers: headers
    parameters: requestData
];

if (response.get("status_code") == 200) {
    info "Request successful";
    responseData = response.get("response");
    info responseData;
} else {
    info "Request failed with status: " + response.get("status_code");
    info response.get("response");
}

PUT Update Member Role

PUT https://show.zoho.com/api/v1/presentation/{rid}/members

Required Scopes:

ZohoShow.showdocslist.UPDATE

Changes an existing member's role on a presentation. Use to upgrade or downgrade a single member's permissions.

Path parameters

Name	Type	Required	Description
rid	string	Required	Resource id of the presentation. The caller must have the appropriate permission on this presentation.

Samples

Request Body

JSON

{
  "share_params": {
    "email_id": "{{email_id}}"
  },
  "role": "COOWNER"
}

Responses

200 Member Role Updated

500 User not shared on this presentation

401 Missing OAuth Token

400 Invalid Resource ID

405 Invalid Method

{
  "data": {
    "status": true
  },
  "message": "User role updated",
  "request_uri": "/api/v1/presentation/cpnv3d0203ec89cba4207ba255d785dfe125c/members",
  "status": "success"
}

Code Examples

cURL

curl -X PUT "https://show.zoho.com/api/v1/presentation/{rid}/members" \
  -H "Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "share_params": {
    "email_id": "{{email_id}}"
  },
  "role": "COOWNER"
}'

JavaScript

const response = await fetch('https://show.zoho.com/api/v1/presentation/{rid}/members', {
  method: 'PUT',
  headers: {
    'Authorization': 'Zoho-oauthtoken YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "share_params": {
    "email_id": "{{email_id}}"
  },
  "role": "COOWNER"
})
});

const data = await response.json();
// Process the response data
return data;

Node.js

const https = require('https');
const url = require('url');

const options = {
  ...url.parse('https://show.zoho.com/api/v1/presentation/{rid}/members'),
  method: 'PUT',
  headers: {
    'Authorization': 'Zoho-oauthtoken YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => data += chunk);
  res.on('end', () => {
    const result = JSON.parse(data);
    // Process the response data
  });
});

req.write(JSON.stringify({
  "share_params": {
    "email_id": "{{email_id}}"
  },
  "role": "COOWNER"
}));
req.end();

Python

import requests

url = "https://show.zoho.com/api/v1/presentation/{rid}/members"
headers = {
    "Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
}

data = {
  "share_params": {
    "email_id": "{{email_id}}"
  },
  "role": "COOWNER"
}

response = requests.put(url, headers=headers, json=data)
data = response.json()
print(data)

Java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import java.time.Duration;

public class ApiClient {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newBuilder()
            .connectTimeout(Duration.ofSeconds(10))
            .build();

        HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
            .uri(URI.create("https://show.zoho.com/api/v1/presentation/{rid}/members"))
            .header("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN")
            .timeout(Duration.ofSeconds(30));

            .header("Content-Type", "application/json")
        String requestBody = "{\"share_params\":{\"email_id\":\"{{email_id}}\"},\"role\":\"COOWNER\"}";
        HttpRequest request = requestBuilder
            .PUT(HttpRequest.BodyPublishers.ofString(requestBody))
            .build();

        HttpResponse<String> response = client.send(request,
            HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

Deluge

info "Making API request to: https://show.zoho.com/api/v1/presentation/{rid}/members";

headers = Map();
headers.put("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN");
headers.put("Content-Type", "application/json");

requestData = {"share_params": {"email_id": "{{email_id}}"}, "role": "COOWNER"};

response = invokeurl
[
    url: "https://show.zoho.com/api/v1/presentation/{rid}/members"
    type: PUT
    headers: headers
    parameters: requestData
];

if (response.get("status_code") == 200) {
    info "Request successful";
    responseData = response.get("response");
    info responseData;
} else {
    info "Request failed with status: " + response.get("status_code");
    info response.get("response");
}

DELETE Remove Member (Unshare)

DELETE https://show.zoho.com/api/v1/presentation/{rid}/members

Required Scopes:

ZohoShow.showdocslist.DELETE WorkDrive.files.sharing.DELETE WorkDrive.files.READ

Revokes access to a presentation for a user or group. Can target individual users by email or groups by id.

Path parameters

Name	Type	Required	Description
rid	string	Required	Resource id of the presentation. The caller must have the appropriate permission on this presentation.

Samples

Request Body

JSON

{
  "email_id": "{{email_id}}"
}

Responses

200 Member removed

500 Unshared Presentation

400 Non Member

401 Missing OAuth Token

400 Invalid Resource ID

{
  "data": {
    "status": true
  },
  "message": "Share removed",
  "request_uri": "/api/v1/presentation/cpnv3d0203ec89cba4207ba255d785dfe125c/members",
  "status": "success"
}

Code Examples

cURL

curl -X DELETE "https://show.zoho.com/api/v1/presentation/{rid}/members" \
  -H "Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "email_id": "{{email_id}}"
}'

JavaScript

const response = await fetch('https://show.zoho.com/api/v1/presentation/{rid}/members', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Zoho-oauthtoken YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "email_id": "{{email_id}}"
})
});

const data = await response.json();
// Process the response data
return data;

Node.js

const https = require('https');
const url = require('url');

const options = {
  ...url.parse('https://show.zoho.com/api/v1/presentation/{rid}/members'),
  method: 'DELETE',
  headers: {
    'Authorization': 'Zoho-oauthtoken YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => data += chunk);
  res.on('end', () => {
    const result = JSON.parse(data);
    // Process the response data
  });
});

req.write(JSON.stringify({
  "email_id": "{{email_id}}"
}));
req.end();

Python

import requests

url = "https://show.zoho.com/api/v1/presentation/{rid}/members"
headers = {
    "Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
}

data = {
  "email_id": "{{email_id}}"
}

response = requests.delete(url, headers=headers, json=data)
data = response.json()
print(data)

Java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import java.time.Duration;

public class ApiClient {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newBuilder()
            .connectTimeout(Duration.ofSeconds(10))
            .build();

        HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
            .uri(URI.create("https://show.zoho.com/api/v1/presentation/{rid}/members"))
            .header("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN")
            .timeout(Duration.ofSeconds(30));

            .header("Content-Type", "application/json")
        String requestBody = "{\"email_id\":\"{{email_id}}\"}";
        HttpRequest request = requestBuilder
            .DELETE(HttpRequest.BodyPublishers.ofString(requestBody))
            .build();

        HttpResponse<String> response = client.send(request,
            HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

Deluge

info "Making API request to: https://show.zoho.com/api/v1/presentation/{rid}/members";

headers = Map();
headers.put("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN");
headers.put("Content-Type", "application/json");

requestData = {"email_id": "{{email_id}}"};

response = invokeurl
[
    url: "https://show.zoho.com/api/v1/presentation/{rid}/members"
    type: DELETE
    headers: headers
    parameters: requestData
];

if (response.get("status_code") == 200) {
    info "Request successful";
    responseData = response.get("response");
    info responseData;
} else {
    info "Request failed with status: " + response.get("status_code");
    info response.get("response");
}