{ "item": [ { "id": "29405064-bc61-46c5-90cf-21872326c987", "name": "External Share", "description": { "content": "Publish, update, revoke, and inspect external shares.", "type": "text/plain" }, "item": [ { "id": "c90715fb-f0da-4e48-89c4-41815873ae43", "name": "Check whether external sharing is allowed for the edition and team", "request": { "name": "Check whether external sharing is allowed for the edition and team", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "externalshares", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "external_share_team_enabled", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: external_share_edition_enabled, external_share_team_enabled, external_share_allowed" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "18a782f6-6e91-4dab-8380-177fb75bb808", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "externalshares", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "external_share_team_enabled" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"external_share_edition_enabled\": true\n },\n \"message\": \"External share status fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/888012145/teams/4855000000002003/externalshares/status\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2dac43f9-be22-4391-b671-5bdec7bda7e2", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "externalshares", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "external_share_team_enabled" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"key_0\": 4334.647698597465\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8657cb81-3e17-42eb-b6b9-ccce04d80117", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "externalshares", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "external_share_team_enabled" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"key_0\": 4334.647698597465\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c7a5d5f-209b-4392-bb29-96ad0928a46e", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "externalshares", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "external_share_team_enabled" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"key_0\": 4334.647698597465\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b3d5016-c7b7-44ef-bfbb-affdf2c96788", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "externalshares", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "external_share_team_enabled" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"key_0\": 4334.647698597465\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38c6ce4c-05b7-4ddb-90b9-cad357e441ed", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "externalshares", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "external_share_team_enabled" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"key_0\": 4334.647698597465\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6afa2987-ac5d-41f1-b7c2-1d2b46e5a49f", "name": "Publish a space as an external share", "request": { "name": "Publish a space as an external share", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"ALL_ZONES\",\n \"is_password_enabled\": true,\n \"zone_ids\": \"7D3AD400-CDDa-1cc4-B8AC-dF0f787E60CB\",\n \"password\": \"KS\",\n \"expiration_time\": \"string\",\n \"link_name\": \"q'ssaRqI!\",\n \"external_share_id\": \"WYm9P1.HJ\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a627b647-ac9d-44a6-8a44-68f9ef7df801", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"ALL_ZONES\",\n \"is_password_enabled\": true,\n \"zone_ids\": \"7D3AD400-CDDa-1cc4-B8AC-dF0f787E60CB\",\n \"password\": \"KS\",\n \"expiration_time\": \"string\",\n \"link_name\": \"q'ssaRqI!\",\n \"external_share_id\": \"WYm9P1.HJ\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"is_password_enabled\": true,\n \"zone_ids\": [\n {\n \"zone_id\": \"9e7a947b-470b-46e7-be64-4a617abadf43\",\n \"permission\": \"VIEWER\"\n }\n ],\n \"password\": \"1\",\n \"share_type\": \"PARTIAL_ZONES\",\n \"shared_time\": 1752045010623,\n \"external_share_url\": \"https://app.vanipublic.com/external/open/92c8c172434d1eb794100b0e52303ddaf6ec81d29608502e2b8bce9a5aab731144024ea162631784c784141d8d79c5e3e433279e6f2a4f0841ecfb01ea995155\",\n \"expiration_time\": 1754627011000,\n \"shared_by\": 82512958,\n \"permission\": \"VIEWER\",\n \"space_id\": \"1629000000297013\"\n },\n \"message\": \"Space externally shared successfully\",\n \"request_uri\": \"/vani/api/v1/editions/82513223/spaces/1629000000297013/externalshares\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea07a227-4f16-4901-8d8a-7edbc3aa758f", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"ALL_ZONES\",\n \"is_password_enabled\": true,\n \"zone_ids\": \"7D3AD400-CDDa-1cc4-B8AC-dF0f787E60CB\",\n \"password\": \"KS\",\n \"expiration_time\": \"string\",\n \"link_name\": \"q'ssaRqI!\",\n \"external_share_id\": \"WYm9P1.HJ\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"82513223\",\n \"current_user_id\": \"82512958\",\n \"error_code\": \"EX1006\",\n \"message\": \"External share zones are invalid or not available\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/82513223/spaces/1629000000297013/externalshares\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93c5cdc9-2a19-4166-b61b-31a42a0bdaf4", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"ALL_ZONES\",\n \"is_password_enabled\": true,\n \"zone_ids\": \"7D3AD400-CDDa-1cc4-B8AC-dF0f787E60CB\",\n \"password\": \"KS\",\n \"expiration_time\": \"string\",\n \"link_name\": \"q'ssaRqI!\",\n \"external_share_id\": \"WYm9P1.HJ\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"key_0\": 4334.647698597465\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22031631-1270-4e03-b8ff-7e6ee583eb22", "name": "Forbidden - the caller is authenticated but not allowed to perform this operation", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"ALL_ZONES\",\n \"is_password_enabled\": true,\n \"zone_ids\": \"7D3AD400-CDDa-1cc4-B8AC-dF0f787E60CB\",\n \"password\": \"KS\",\n \"expiration_time\": \"string\",\n \"link_name\": \"q'ssaRqI!\",\n \"external_share_id\": \"WYm9P1.HJ\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"82513223\",\n \"current_user_id\": \"82512958\",\n \"error_code\": \"EX1003\",\n \"message\": \"External share is not allowed for this team\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/82513223/spaces/1629000000297013/externalshares\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22f28b6b-f90c-43d1-866b-da7f08c2231c", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"ALL_ZONES\",\n \"is_password_enabled\": true,\n \"zone_ids\": \"7D3AD400-CDDa-1cc4-B8AC-dF0f787E60CB\",\n \"password\": \"KS\",\n \"expiration_time\": \"string\",\n \"link_name\": \"q'ssaRqI!\",\n \"external_share_id\": \"WYm9P1.HJ\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"key_0\": 4334.647698597465\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a02a654-50c5-4071-a0ec-35a16d816564", "name": "Conflict - the requested change conflicts with the current resource state", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"ALL_ZONES\",\n \"is_password_enabled\": true,\n \"zone_ids\": \"7D3AD400-CDDa-1cc4-B8AC-dF0f787E60CB\",\n \"password\": \"KS\",\n \"expiration_time\": \"string\",\n \"link_name\": \"q'ssaRqI!\",\n \"external_share_id\": \"WYm9P1.HJ\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"112255940\",\n \"current_user_id\": \"82512958\",\n \"error_code\": \"EX1019\",\n \"message\": \"External share limit reached for the project.\",\n \"space_id\": \"5777000000929039\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/112255940/spaces/5777000000929039/externalshares\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d2e18da-6a15-45a3-b9f8-f0bc572ef165", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"ALL_ZONES\",\n \"is_password_enabled\": true,\n \"zone_ids\": \"7D3AD400-CDDa-1cc4-B8AC-dF0f787E60CB\",\n \"password\": \"KS\",\n \"expiration_time\": \"string\",\n \"link_name\": \"q'ssaRqI!\",\n \"external_share_id\": \"WYm9P1.HJ\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"key_0\": 4334.647698597465\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06dfc07d-3dcd-4771-8e27-35b9094449b8", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"ALL_ZONES\",\n \"is_password_enabled\": true,\n \"zone_ids\": \"7D3AD400-CDDa-1cc4-B8AC-dF0f787E60CB\",\n \"password\": \"KS\",\n \"expiration_time\": \"string\",\n \"link_name\": \"q'ssaRqI!\",\n \"external_share_id\": \"WYm9P1.HJ\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"key_0\": 4334.647698597465\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1fae82d2-e66b-4a40-a19f-5bcfe1cd0eb8", "name": "Get a space's external share details", "request": { "name": "Get a space's external share details", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "zone_ids", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: space_id, position, shared_by, permission, share_type, is_password_enabled, password, expiration_time, shared_time, external_share_url, zone_ids, link_name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "f62cd562-172e-481f-8993-4b1a703df795", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zone_ids" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"shared_time\": 1753678990289,\n \"space_id\": \"4855000000088149\"\n },\n \"message\": \"External share space info fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/888012145/spaces/4855000000088149/externalshares\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fd2428f-fb7a-423c-8fd2-d32c8b08f3a1", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zone_ids" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"82513223\",\n \"current_user_id\": \"82512958\",\n \"error_code\": \"S1046\",\n \"message\": \"Space is not externally shared\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/82513223/spaces/1629000000297013/externalshares\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c07a90af-a70d-42ff-829d-faa8722199eb", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zone_ids" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"888012145\",\n \"current_user_id\": \"888015717\",\n \"error_code\": \"EX1007\",\n \"message\": \"The user doesn't have permission to fetch external share info\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/888012145/spaces/485500000008849/externalshares\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b52a68c-0052-42b9-9156-c6080d9b4696", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zone_ids" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"key_0\": 4334.647698597465\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9e83010-2b5e-485f-8863-cd5ad4d89194", "name": "Rate limit exceeded - this operation allows 10 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zone_ids" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"key_0\": 4334.647698597465\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7cf76bc-5e28-432f-bc9f-2fd0ff8d9faa", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zone_ids" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"key_0\": 4334.647698597465\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "49ce7900-d8c9-4979-9413-154136fae624", "name": "Revoke a space's external share", "request": { "name": "Revoke a space's external share", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"external_share_id\": \"C37-MiXo.H\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f7cb75f1-02ba-4e57-b86a-cbbbb71ee268", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"external_share_id\": \"C37-MiXo.H\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"space_id\": \"3009000000675145\",\n \"external_share_removed\": true\n },\n \"message\": \"External share space removed successfully\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000675145/externalshares\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83fab2ca-be1f-4da6-b6f6-ae11b96a9e60", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"external_share_id\": \"C37-MiXo.H\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"82513223\",\n \"current_user_id\": \"82512958\",\n \"error_code\": \"S1046\",\n \"message\": \"Space is not externally shared\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/82513223/spaces/1629000000297013/externalshares\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78f94999-1c81-4e32-8d31-d8fa8e471cef", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"external_share_id\": \"C37-MiXo.H\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"key_0\": 4334.647698597465\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a940621-63e2-4d10-b063-51a55b048280", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"external_share_id\": \"C37-MiXo.H\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"S1009\",\n \"message\": \"Space not found\",\n \"space_id\": \"300900000675145\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/300900000675145/externalshares\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85266e9f-4144-4def-8ebd-27faca4ed693", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"external_share_id\": \"C37-MiXo.H\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"key_0\": 4334.647698597465\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9ecbc76-c936-4198-adcd-9eb4ce2f5855", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"external_share_id\": \"C37-MiXo.H\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"key_0\": 4334.647698597465\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "38db4ea7-d51d-4507-840c-8d250a7add50", "name": "Update a space's external share", "request": { "name": "Update a space's external share", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"ALL_ZONES\",\n \"is_password_enabled\": true,\n \"zone_ids\": \"7D3AD400-CDDa-1cc4-B8AC-dF0f787E60CB\",\n \"password\": \"KS\",\n \"expiration_time\": \"string\",\n \"link_name\": \"q'ssaRqI!\",\n \"external_share_id\": \"WYm9P1.HJ\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3029d8e6-1dba-48e1-8c52-0f9d39a7e5d7", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"ALL_ZONES\",\n \"is_password_enabled\": true,\n \"zone_ids\": \"7D3AD400-CDDa-1cc4-B8AC-dF0f787E60CB\",\n \"password\": \"KS\",\n \"expiration_time\": \"string\",\n \"link_name\": \"q'ssaRqI!\",\n \"external_share_id\": \"WYm9P1.HJ\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"is_password_enabled\": true,\n \"zone_ids\": [\n {\n \"zone_id\": \"9e7a947b-470b-46e7-be64-4a617abadf43\",\n \"permission\": \"COMMENTER\"\n }\n ],\n \"password\": \"1\",\n \"share_type\": \"PARTIAL_ZONES\",\n \"shared_time\": 1752045307273,\n \"external_share_url\": \"https://app.localvanipublic.net/external/open/ea6e71f11f7803677667dec29fc1ea2ea829c2b748a992203c8a3eea26b853568c231f96663a6b841b11c071352ee65b844d010ea52cf7e3810a7bc43c2b8c7f\",\n \"expiration_time\": 1754627011000,\n \"shared_by\": 82512958,\n \"permission\": \"COMMENTER\",\n \"space_id\": \"1629000000297013\"\n },\n \"message\": \"External share space updated successfully\",\n \"request_uri\": \"/vani/api/v1/editions/82513223/spaces/1629000000297013/externalshares\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd5d55c6-dde7-4e41-9999-3def7308f29d", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"ALL_ZONES\",\n \"is_password_enabled\": true,\n \"zone_ids\": \"7D3AD400-CDDa-1cc4-B8AC-dF0f787E60CB\",\n \"password\": \"KS\",\n \"expiration_time\": \"string\",\n \"link_name\": \"q'ssaRqI!\",\n \"external_share_id\": \"WYm9P1.HJ\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"82513223\",\n \"current_user_id\": \"82512958\",\n \"error_code\": \"EX1006\",\n \"message\": \"External share zones are invalid or not available\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/82513223/spaces/1629000000297013/externalshares\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7789be4e-9689-490c-89c8-8ca1e904da7c", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"ALL_ZONES\",\n \"is_password_enabled\": true,\n \"zone_ids\": \"7D3AD400-CDDa-1cc4-B8AC-dF0f787E60CB\",\n \"password\": \"KS\",\n \"expiration_time\": \"string\",\n \"link_name\": \"q'ssaRqI!\",\n \"external_share_id\": \"WYm9P1.HJ\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"key_0\": 4334.647698597465\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2acb9157-3ef3-4dc4-a3b6-266921287bd0", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"ALL_ZONES\",\n \"is_password_enabled\": true,\n \"zone_ids\": \"7D3AD400-CDDa-1cc4-B8AC-dF0f787E60CB\",\n \"password\": \"KS\",\n \"expiration_time\": \"string\",\n \"link_name\": \"q'ssaRqI!\",\n \"external_share_id\": \"WYm9P1.HJ\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"key_0\": 4334.647698597465\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3dc5872-b76f-47c0-bd02-4650a598b4f7", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"ALL_ZONES\",\n \"is_password_enabled\": true,\n \"zone_ids\": \"7D3AD400-CDDa-1cc4-B8AC-dF0f787E60CB\",\n \"password\": \"KS\",\n \"expiration_time\": \"string\",\n \"link_name\": \"q'ssaRqI!\",\n \"external_share_id\": \"WYm9P1.HJ\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"key_0\": 4334.647698597465\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7eb30184-3950-40a2-9e18-1e650d86a64e", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"ALL_ZONES\",\n \"is_password_enabled\": true,\n \"zone_ids\": \"7D3AD400-CDDa-1cc4-B8AC-dF0f787E60CB\",\n \"password\": \"KS\",\n \"expiration_time\": \"string\",\n \"link_name\": \"q'ssaRqI!\",\n \"external_share_id\": \"WYm9P1.HJ\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"key_0\": 4334.647698597465\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c0a4e50b-7ef7-4cd4-b2ba-ce626239dc02", "name": "Get the external shares of a team's spaces", "request": { "name": "Get the external shares of a team's spaces", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "from", "value": "string", "description": "The starting index from where the results should be fetched. Default value is 0" }, { "disabled": false, "key": "limit", "value": "100", "description": "The maximum number of results to return in the response. Default value is 20" }, { "disabled": false, "key": "fields", "value": "zone_ids", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: space_id, position, shared_by, permission, share_type, is_password_enabled, password, expiration_time, shared_time, external_share_url, zone_ids, link_name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "4748f15c-c377-4505-9e19-09b5f31336b7", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "string" }, { "key": "limit", "value": "100" }, { "key": "fields", "value": "zone_ids" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"external_share_info\": [\n {\n \"external_share_url\": \"https://app.vanipublic.com/external/open/418a5ec6abf2bb5b7a0486d5aaae300bcb97a2672a1086e25a81c5853896c92d27a8a01fcb9e42a82fe59e5a3c050fb2390d261c80ae2d4f33b09a56b27f58a5\",\n \"permission\": \"VIEWER\",\n \"space_id\": \"1629000000491005\"\n },\n {\n \"external_share_url\": \"https://app.vanipublic.com/external/open/f42bcd0a8025fe33bd45bcb176e270275b48312abef2bf9d468a4939709cf9a68db1f73db4f8bdfee7fc07d948d360e083ee198913c863c624304fc274c8d289\",\n \"permission\": \"VIEWER\",\n \"space_id\": \"1629000000309025\"\n },\n {\n \"external_share_url\": \"https://app.vanipublic.com/external/open/c7dab478035f95d89f1ad22b507b7bf98bd26c5f33c8d5123f5e85c34ae796ea09b9dd26ae6c0e6ac575a8e387eb98073530e803ecdd2cfa1ba7747726529492\",\n \"permission\": \"COMMENTER\",\n \"space_id\": \"1629000000297013\"\n }\n ]\n },\n \"message\": \"External share spaces fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/82513223/teams/1629000000002003/externalshares\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10f7e2d7-8218-4036-869c-ce24ebb1db0c", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "string" }, { "key": "limit", "value": "100" }, { "key": "fields", "value": "zone_ids" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"key_0\": 4334.647698597465\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f7997ad-38fc-4580-856f-2387e98b729c", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "string" }, { "key": "limit", "value": "100" }, { "key": "fields", "value": "zone_ids" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"key_0\": 4334.647698597465\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8e2ca77-0df2-4215-bcdf-f6a04036bcae", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "string" }, { "key": "limit", "value": "100" }, { "key": "fields", "value": "zone_ids" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"key_0\": 4334.647698597465\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9182a18-86b8-4848-b565-84c57143fb98", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "string" }, { "key": "limit", "value": "100" }, { "key": "fields", "value": "zone_ids" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"key_0\": 4334.647698597465\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e19dc74c-c4fd-4cc9-86ac-2bdceeccde73", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "string" }, { "key": "limit", "value": "100" }, { "key": "fields", "value": "zone_ids" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"key_0\": 4334.647698597465\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.app.vanihq.{{dc}}", "description": "API host. Change {{dc}} to your edition's data-centre TLD." }, { "key": "dc", "value": "com", "description": "Data-centre TLD for your edition. One of: com, in, eu, ca, com.au, sa, ae." } ], "info": { "_postman_id": "b6e479b5-f525-440d-920c-a9a0ced5e2c7", "name": "External Share", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Publish a space externally and manage the resulting public share." } }