{ "item": [ { "id": "a5575e86-1726-4819-987d-c75508b1eee6", "name": "Editions", "description": { "content": "Read and create editions, and check edition join-request status.", "type": "text/plain" }, "item": [ { "id": "25b566bf-8516-4737-9f07-c6bc36676d67", "name": "Read whether access-request handling is switched on for the edition. Use to check the org-level toggle before a user tries to request access to a team or space.", "request": { "name": "Read whether access-request handling is switched on for the edition. Use to check the org-level toggle before a user tries to request access to a team or space.", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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": "c2c7fa27-f0de-4358-9b42-c68d86639628", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 \"edition_id\": \"96499735\",\n \"status\": \"true\"\n },\n \"message\": \"Requests status fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/requests/status\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a727db7d-8b9d-4457-bd76-755744605f45", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5edb82d7-1074-4b06-abc7-2abcfe9b1a14", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0d47413-86e5-4b8a-9e2f-7f4027718739", "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", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4701e497-2648-416a-b74a-99e7bdcb8bc0", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f75cca71-f6a9-443e-b974-cf70367eda43", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2d892859-2d0f-47cc-8843-4908ef08b5f5", "name": "Approve or reject an edition join request", "request": { "name": "Approve or reject an edition join request", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 \"enabled\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4b96d014-a64d-4364-ad76-68f642aa0ced", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 \"enabled\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"edition_id\": \"96499735\",\n \"status\": \"false\"\n },\n \"message\": \"Requests status updated successfully\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/requests/status\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91d8c02a-96fc-49ae-ac46-fd6593057a1c", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 \"enabled\": false\n}", "options": { "raw": { "language": "json" } } } }, "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bcd792c-adba-43df-b3ed-8266cb04600a", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 \"enabled\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/112255940/requests/status\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8645ea7-9dd6-4148-a08b-de2475447813", "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", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 \"enabled\": false\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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8adad0b-e9e4-4e11-9e6b-403179565294", "name": "Conflict - the requested change conflicts with the current resource state", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 \"enabled\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"E1015\",\n \"message\": \"Team Request status is already in the requested state\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/requests/status\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b91262d7-92f9-4d31-a9ea-44b3df2171f0", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 \"enabled\": false\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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cadff1f0-baad-4320-8034-ac582791b35a", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 \"enabled\": false\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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6fb03b1d-ddbe-4a08-a769-ddc8a4c7a290", "name": "Get an edition", "request": { "name": "Get an edition", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "edition_role_name", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: state, created_time, last_modified_time, edition_type_name, edition_name, edition_role_name, edition_id, edition_owner_id, is_default, uri" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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": "bf91cff6-8600-4282-a706-a09411ae7e7a", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "edition_role_name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 \"edition_info\": {\n \"state\": \"ACTIVE\",\n \"edition_name\": \"QA TEAM\",\n \"edition_owner_id\": \"96384499\"\n }\n },\n \"message\": \"Editions fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/60029715808\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd9c4d60-7f24-45c5-a60f-79cbbffbee06", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "edition_role_name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55ee239c-911d-453f-a623-fddc5b4fcbfc", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "edition_role_name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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\": \"96499735\",\n \"error_code\": \"A1008\",\n \"message\": \"Given API Key is not valid.\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1227c6e4-7095-48cf-832a-32bd60cf11a4", "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" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "edition_role_name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2891388-7d0e-44bb-b5a2-562fab989b11", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "edition_role_name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90748a92-48be-4472-b2cc-11623a288a8d", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "edition_role_name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f97b22e0-a716-4a8f-9d75-f477bd83d284", "name": "Create a new edition", "request": { "name": "Create a new edition", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"team_name\": \"㷣験\",\n \"plan_type\": \"TRIAL\",\n \"description\": \"핪씳瘟蒫톜Ȧ띮\",\n \"from_integration\": \"ZOHO_MAIL\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "345880ca-d5b5-40f3-8b0e-4dd78f820563", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"team_name\": \"㷣験\",\n \"plan_type\": \"TRIAL\",\n \"description\": \"핪씳瘟蒫톜Ȧ띮\",\n \"from_integration\": \"ZOHO_MAIL\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"edition_id\": \"98723605\",\n \"current_user_id\": \"98722154\",\n \"team_id\": 5265000000002003,\n \"team_name\": \"TeamEdition\"\n },\n \"message\": \"Team edition created successfully\",\n \"request_uri\": \"/vani/api/v1/editions\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69a2d8ed-c7c3-4a40-b9f8-ab81c3b0c210", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"team_name\": \"㷣験\",\n \"plan_type\": \"TRIAL\",\n \"description\": \"핪씳瘟蒫톜Ȧ띮\",\n \"from_integration\": \"ZOHO_MAIL\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"IAM1031\",\n \"attribute\": \"team_name\",\n \"message\": \"The required parameter is missing\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8770dc1-47b1-4e15-8b79-adf33739608c", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"team_name\": \"㷣験\",\n \"plan_type\": \"TRIAL\",\n \"description\": \"핪씳瘟蒫톜Ȧ띮\",\n \"from_integration\": \"ZOHO_MAIL\"\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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77c822e1-f291-475b-a3b3-e2e8c80ee27a", "name": "Conflict - the requested change conflicts with the current resource state", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"team_name\": \"㷣験\",\n \"plan_type\": \"TRIAL\",\n \"description\": \"핪씳瘟蒫톜Ȧ띮\",\n \"from_integration\": \"ZOHO_MAIL\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"current_user_id\": \"98722154\",\n \"error_code\": \"E1001\",\n \"message\": \"User has already created an edition\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ccf0ce2-cad7-430f-b938-260f7d714441", "name": "Rate limit exceeded - this operation allows 10 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"team_name\": \"㷣験\",\n \"plan_type\": \"TRIAL\",\n \"description\": \"핪씳瘟蒫톜Ȧ띮\",\n \"from_integration\": \"ZOHO_MAIL\"\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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d436ceb2-5da8-4766-bf88-69e3ba4a8059", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"team_name\": \"㷣験\",\n \"plan_type\": \"TRIAL\",\n \"description\": \"핪씳瘟蒫톜Ȧ띮\",\n \"from_integration\": \"ZOHO_MAIL\"\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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "558f9500-4685-445f-951a-8d722c38de79", "name": "Get all editions the user belongs to", "request": { "name": "Get all editions the user belongs to", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "edition_role_name", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: state, created_time, last_modified_time, edition_type_name, edition_name, edition_role_name, edition_id, edition_owner_id, is_default, uri" } ], "variable": [ { "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": "24deeeae-a4ac-49b3-b119-da7ece3371e4", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "edition_role_name" } ], "variable": [ { "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 \"editions_info\": {}\n },\n \"message\": \"Editions fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a4ca391-6ace-43ca-866e-0f9f444211ec", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "edition_role_name" } ], "variable": [ { "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3273aa7-05cb-4071-a59c-05f993bf3a38", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "edition_role_name" } ], "variable": [ { "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e155edf-f890-4d1b-b5cd-2120570190ff", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "edition_role_name" } ], "variable": [ { "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a24d0f7-93b0-4bc4-9b7a-bf442ee416d8", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "edition_role_name" } ], "variable": [ { "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "00fa591a-7039-40f5-80c7-eb6b556cb34e", "name": "Subscription", "description": { "content": "Read the edition's subscription details.", "type": "text/plain" }, "item": [ { "id": "7be52832-6d77-44e8-8d0b-bab742a5ba67", "name": "Get the edition's subscription details", "request": { "name": "Get the edition's subscription details", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "expiry_date", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: status, members_count, edition_id, purchase_date, plan_name, plan_type, expiry_date" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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": "3c30cb6f-2ea4-4724-9ab8-1248ae4ff185", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "expiry_date" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 \"subscription_info\": {\n \"plan_type\": \"Yearly\",\n \"edition_id\": \"112255940\",\n \"expiry_date\": \"Sat, 19 Jun 2027, 00:00:00\",\n \"members_count\": \"5\",\n \"purchase_date\": \"Fri, 19 Jun 2026, 18:56:49\",\n \"plan_name\": \"BUSINESS_PLAN\",\n \"status\": \"Active\"\n }\n },\n \"message\": \"Subscription details fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/112255940/subscription\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69a1d816-13dc-4940-95aa-25315801529b", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "expiry_date" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae1e3a5b-9867-4b80-b14b-4d46a7f72008", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "expiry_date" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f8978a7-e548-40f9-a192-3b37583b22b4", "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", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "expiry_date" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94adadbf-9ab1-4b44-acea-4c08693117a6", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "expiry_date" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9061f0a5-80e2-4ab7-ac55-ab6adfba7c9b", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "expiry_date" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "474449a9-eeaf-4f2f-a7a9-6008dfcdcbe5", "name": "Templates", "description": { "content": "List and read the templates available in an edition.", "type": "text/plain" }, "item": [ { "id": "224ee5ea-8e50-4981-bd2a-0a74cba92464", "name": "Get the templates available in an edition", "request": { "name": "Get the templates available in an edition", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "is_available_for_edition", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: id, description, name, is_available_for_edition" }, { "disabled": false, "key": "from", "value": "051205", "description": "The starting index from where the results should be fetched. Default value is 0" }, { "disabled": false, "key": "limit", "value": "442", "description": "The maximum number of results to return in the response. Default value is 20" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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": "76dfd38c-f476-4598-ade1-e21a7a0a6f94", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "is_available_for_edition" }, { "key": "from", "value": "051205" }, { "key": "limit", "value": "442" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 \"templates\": [\n {\n \"name\": \"Eisenhower matrix\",\n \"description\": \"The Eisenhower Matrix, also known as the Urgent-Important Matrix, is a productivity tool used to prioritize tasks based on their urgency and importance.\",\n \"id\": \"2227813839241884264\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"1-on-1 feedback\",\n \"description\": \"Help your mentor or teammate get an idea of what you're going to discuss with them in your 1-on-1 feedback sessions.\",\n \"id\": \"415170746673786701\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"5 whys\",\n \"description\": \"Find the root cause of a problem by asking "Why?" questions.\",\n \"id\": \"8825346814681087568\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Guess the Doodle\",\n \"description\": \"Just want to chill with the team for a while? This visual game will help you and your team relax and bond with each other.\",\n \"id\": \"7193564480716665813\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Impact Effort Matrix\",\n \"description\": \"An impact effort matrix is a tool used in project management to help prioritize tasks based on their level of impact and effort required.\",\n \"id\": \"4880489140950000824\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Customer problem statement\",\n \"description\": \"Get into your customer's shoes to better understand their problems. \",\n \"id\": \"3570349084835838944\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Marketing release checklist\",\n \"description\": \"Got an upcoming release? Here's an easier way to plan and execute\\nyour marketing goals, so that you get everything covered.\",\n \"id\": \"5252159967532415789\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Never Have I Ever\",\n \"description\": \"Never Have I Ever is a popular card game designed to reveal interesting and embarrassing secrets about the players. It's a great icebreaker and often opens up fun, entertaining conversations.\",\n \"id\": \"9068022063805355070\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"New teammate onboarding\",\n \"description\": \"Onboard new members of your team with this fun template.\",\n \"id\": \"8077947179536093903\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"New teammate project milestones\",\n \"description\": \"Help your new teammate understand all about your team's projects, the stuff they need to work on, and the expectations you've set for them.\\r\\n\",\n \"id\": \"2197960956629199196\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Sales call follow-up\",\n \"description\": \"This is a quick way to share insights after a sales call and discuss them with your team.\",\n \"id\": \"1758538615716321335\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Product positioning\",\n \"description\": \"Working on a new product or revising an existing one? Here are some positioning exercises for you and your teammates to brainstorm and fill in.\\r\\n\",\n \"id\": \"4786897632740503006\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Strategic goal board\",\n \"description\": \"Chart out some goals and work together with your teammates towards achieving them.\\r\\n\",\n \"id\": \"146806559048094029\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Team bookshelf\",\n \"description\": \"Build your team library with book recommendations from everyone.\",\n \"id\": \"2601700237097182900\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Team coffee discussion\",\n \"description\": \"Bond with your team over coffee, or just about anything you want, and have fun discussions.\",\n \"id\": \"6282257423499599528\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Team priority : Now, Next, Later\",\n \"description\": \"Working on your next team project? Quickly list down tasks and details, sort the most-important things to do, and keep track of the progress.\\r\\n\",\n \"id\": \"1189335149816408152\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Team recipe board\",\n \"description\": \"A fun team activity to share the best and favorite recipes with each other.\",\n \"id\": \"709495071782421321\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Website signup flow\",\n \"description\": \"A simple sign up flow to capture the visitor-to-subscriber conversion.\",\n \"id\": \"5772067647393374657\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Weekly team planner\",\n \"description\": \"Plan your week with your teammates using this template.\\r\\n\",\n \"id\": \"3212028571933595674\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Book Club Meeting\",\n \"description\": \"Use this template to jot down your bookish discussions and thoughts on what you are reading and keep track of your literary adventures. It is your cozy digital den for all things book-related.\",\n \"id\": \"2053719903222126011\",\n \"is_available_for_edition\": \"true\"\n }\n ]\n },\n \"message\": \"Templates fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/888012145/templates\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3fbd8ee-e7e6-4257-9aba-ab658ac05ea5", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "is_available_for_edition" }, { "key": "from", "value": "051205" }, { "key": "limit", "value": "442" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94a01066-34d3-46b2-be5e-94936f8c6c6d", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "is_available_for_edition" }, { "key": "from", "value": "051205" }, { "key": "limit", "value": "442" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23f98c49-e809-4f63-b370-c341a180c216", "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", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "is_available_for_edition" }, { "key": "from", "value": "051205" }, { "key": "limit", "value": "442" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b7a36ea-370d-419c-85ee-722d2090aa6d", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "is_available_for_edition" }, { "key": "from", "value": "051205" }, { "key": "limit", "value": "442" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ea9df7a-9660-4e47-8b66-b2f161114d0d", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "is_available_for_edition" }, { "key": "from", "value": "051205" }, { "key": "limit", "value": "442" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e09af5a9-687a-4ca2-8381-d4a38b0e729c", "name": "Get a template", "request": { "name": "Get a template", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "is_available_for_edition", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: id, description, name, is_available_for_edition" } ], "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": "template_id", "description": "(Required) The unique identifier of the template" }, { "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": "3fe4e634-4eab-431a-9ee8-96e2b10e74cb", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "is_available_for_edition" } ], "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": "template_id", "description": "(Required) The unique identifier of the template" }, { "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 \"template\": {\n \"name\": \"1-on-1 feedback\",\n \"description\": \"Help your mentor or teammate get an idea of what you're going to discuss with them in your 1-on-1 feedback sessions.\",\n \"id\": \"415170746673786701\",\n \"is_available_for_edition\": \"true\"\n }\n },\n \"message\": \"Template fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/888012145/templates/415170746673786701\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83a332fb-a53b-4129-ba50-1867d9e4b266", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "is_available_for_edition" } ], "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": "template_id", "description": "(Required) The unique identifier of the template" }, { "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3830dcb-e10a-4136-9f4a-b87594e59c02", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "is_available_for_edition" } ], "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": "template_id", "description": "(Required) The unique identifier of the template" }, { "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8155b60f-cf47-42c9-ae38-45240e9d31c2", "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", "templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "is_available_for_edition" } ], "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": "template_id", "description": "(Required) The unique identifier of the template" }, { "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 \"edition_id\": \"888012145\",\n \"current_user_id\": \"888015717\",\n \"error_code\": \"S1030\",\n \"message\": \"Template not found\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/888012145/templates/339360394209299546\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fb20646-a84e-4a9d-8ca4-a6517f7ef963", "name": "Rate limit exceeded - this operation allows 500 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "is_available_for_edition" } ], "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": "template_id", "description": "(Required) The unique identifier of the template" }, { "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e694efc1-718d-42b8-b30b-3725576554f8", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "is_available_for_edition" } ], "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": "template_id", "description": "(Required) The unique identifier of the template" }, { "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 }\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": "386a8b2a-6480-43a5-988c-aadd253e8cb2", "name": "Editions", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Edition-level resources: the edition itself, its subscription, join requests, and templates." } }