{ "item": [ { "id": "1b4f6287-0757-400a-86ae-4f06039d9d34", "name": "Zones", "description": { "content": "Create, duplicate, move, and update zones, read their metadata, and insert templates into them.", "type": "text/plain" }, "item": [ { "id": "920c0205-e0f6-4bf0-99bd-e2f27a07c1aa", "name": "Move a zone to another space", "request": { "name": "Move a zone to another space", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "move" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"move_zone\": {\n \"destination_type\": \"EXISTING_SPACE\",\n \"space_name\": \"ٱ马蔳㎅䞰슿햯뵺見尺\",\n \"deep_copy\": false,\n \"team_id\": \"string\",\n \"destination_space_id\": \"string\",\n \"copy_comments\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "91dd4d6a-eaf9-4bdd-82ef-20a4f84fadf9", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "move" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"move_zone\": {\n \"destination_type\": \"EXISTING_SPACE\",\n \"space_name\": \"ٱ马蔳㎅䞰슿햯뵺見尺\",\n \"deep_copy\": false,\n \"team_id\": \"string\",\n \"destination_space_id\": \"string\",\n \"copy_comments\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"space_info\": {\n \"created_time\": \"Mon, 10 Mar 2025, 10:42:20\",\n \"last_modified_time\": \"Mon, 10 Mar 2025, 10:42:20\",\n \"is_favorite\": \"false\",\n \"space_name\": \"Project proposal\",\n \"publish\": \"false\",\n \"owner_zuid\": \"96384499\",\n \"can_edit\": \"true\",\n \"allow_embed\": \"false\",\n \"team_id\": \"693000000435005\",\n \"space_id\": \"693000000569361\",\n \"last_author_zuid\": \"96384499\",\n \"status\": \"ACTIVE\"\n }\n },\n \"message\": \"Zone moved successfully\",\n \"request_uri\": \"/vani/api/v1/editions/75918186/spaces/693000000569005/zones/4a971774-9ea7-4f1b-94c8-7199a254d6ba/move\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e6627c4-f43f-41fb-a0dc-00d5d42a77c3", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "move" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"move_zone\": {\n \"destination_type\": \"EXISTING_SPACE\",\n \"space_name\": \"ٱ马蔳㎅䞰슿햯뵺見尺\",\n \"deep_copy\": false,\n \"team_id\": \"string\",\n \"destination_space_id\": \"string\",\n \"copy_comments\": true\n }\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": "3f3ea26f-914f-4869-a429-ee9e6b790d05", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "move" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"move_zone\": {\n \"destination_type\": \"EXISTING_SPACE\",\n \"space_name\": \"ٱ马蔳㎅䞰슿햯뵺見尺\",\n \"deep_copy\": false,\n \"team_id\": \"string\",\n \"destination_space_id\": \"string\",\n \"copy_comments\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"75918186\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"693000000481013\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/75918186/spaces/693000000481013/zones/61fae7ca-ebcc-4ab9-881c-07b1aa9c814b/move\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d0024b8-cfd1-408a-bc14-0ea4ed0839e1", "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", "zones", ":zone_id", "move" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"move_zone\": {\n \"destination_type\": \"EXISTING_SPACE\",\n \"space_name\": \"ٱ马蔳㎅䞰슿햯뵺見尺\",\n \"deep_copy\": false,\n \"team_id\": \"string\",\n \"destination_space_id\": \"string\",\n \"copy_comments\": true\n }\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\": \"75918186\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"S1009\",\n \"message\": \"Space not found\",\n \"space_id\": \"69300000569005\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/75918186/spaces/69300000569005/zones/b313272b-fa45-4111-b61d-de64a0044260/move\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b38c75c-7768-455c-a1d5-d0c9e94d51ae", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "move" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"move_zone\": {\n \"destination_type\": \"EXISTING_SPACE\",\n \"space_name\": \"ٱ马蔳㎅䞰슿햯뵺見尺\",\n \"deep_copy\": false,\n \"team_id\": \"string\",\n \"destination_space_id\": \"string\",\n \"copy_comments\": true\n }\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": "b8194ca1-0332-451b-891b-a50478b0c390", "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", "zones", ":zone_id", "move" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"move_zone\": {\n \"destination_type\": \"EXISTING_SPACE\",\n \"space_name\": \"ٱ马蔳㎅䞰슿햯뵺見尺\",\n \"deep_copy\": false,\n \"team_id\": \"string\",\n \"destination_space_id\": \"string\",\n \"copy_comments\": true\n }\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": "a8ccf2bd-1971-411b-bbc0-959023a9481d", "name": "Create a new zone", "request": { "name": "Create a new zone", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones" ], "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 \"create_zone\": {\n \"zone_name\": \"핕\",\n \"template_id\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c8ebcdeb-adf3-4c2f-bd66-2d93391de191", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones" ], "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 \"create_zone\": {\n \"zone_name\": \"핕\",\n \"template_id\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"zone_info\": {\n \"created_time\": \"Fri, 25 Jul 2025, 06:01:52\",\n \"zone_id\": \"ee01ded6-158e-4729-99b0-257ab23be6d1\",\n \"last_modified_time\": \"Fri, 25 Jul 2025, 06:01:52\",\n \"zone_name\": \"Zone 2\",\n \"space_id\": \"4855000000088149\",\n \"last_author_zuid\": \"888015717\",\n \"author_zuid\": \"888015717\",\n \"status\": \"ACTIVE\"\n }\n },\n \"message\": \"Zone created successfully.\",\n \"request_uri\": \"/vani/api/v1/editions/888012145/spaces/4855000000088149/zones\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96c49fe6-f08e-4b9e-87f8-8cad1c17a6ec", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones" ], "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 \"create_zone\": {\n \"zone_name\": \"핕\",\n \"template_id\": \"string\"\n }\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": "5a0d0c0b-09e2-4adc-a350-91b2977aec73", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones" ], "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 \"create_zone\": {\n \"zone_name\": \"핕\",\n \"template_id\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"300900000005397\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/300900000005397/zones\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c19aea33-2082-4c74-9f98-41a5e6bc81ba", "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", "zones" ], "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 \"create_zone\": {\n \"zone_name\": \"핕\",\n \"template_id\": \"string\"\n }\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\": \"S1030\",\n \"message\": \"Template not found\",\n \"space_id\": \"3009000000419047\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000419047/zones\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc9c92de-a54a-4ba5-ab6b-8b4e30c6487f", "name": "Conflict - the requested change conflicts with the current resource state", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones" ], "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 \"create_zone\": {\n \"zone_name\": \"핕\",\n \"template_id\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"85572652\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"Z1010\",\n \"message\": \"Zone creation limit reached\",\n \"space_id\": \"1600000000657005\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/85572652/spaces/1600000000657005/zones\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54365e38-0c04-4a2a-907f-d5a1bc5fddc9", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones" ], "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 \"create_zone\": {\n \"zone_name\": \"핕\",\n \"template_id\": \"string\"\n }\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": "13de2f0a-20f1-44c7-a43d-626490fcc5cd", "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", "zones" ], "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 \"create_zone\": {\n \"zone_name\": \"핕\",\n \"template_id\": \"string\"\n }\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": "29637d97-431e-48da-919d-0f2ec6532924", "name": "Get zone metadata", "request": { "name": "Get zone metadata", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "meta" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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": "c110cfc6-516d-4d2c-a977-2546d406e7b2", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "meta" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"zone_info\": {\n \"created_time\": \"Tue, 15 Jul 2025, 10:49:13\",\n \"zone_id\": \"c606cdb1-ae46-47a6-847b-0a36caf9f797\",\n \"last_modified_time\": \"Tue, 29 Jul 2025, 13:46:46\",\n \"zone_key\": \"3009000000701095\",\n \"zone_name\": \"Zone 1\",\n \"space_id\": \"3009000000701079\",\n \"author_zuid\": \"96384499\",\n \"last_author_zuid\": \"96384499\",\n \"status\": \"ACTIVE\"\n }\n },\n \"message\": \"Zone metadata fetched successfully.\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000701079/zones/c606cdb1-ae46-47a6-847b-0a36caf9f797/meta\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09dfc6c6-4090-4224-b2d9-179db67966dc", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "meta" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"Z1011\",\n \"message\": \"Zone is not in an active state\",\n \"space_id\": \"3009000000789069\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000789069/zones/e42f51ec-e4dc-4dc5-9587-7a2e49dcdc2e/meta\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca32916b-f796-451f-89f1-c70684070adb", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "meta" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"3009000000789069\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000789069/zones/e42f51ec-e4dc-4dc5-9587-7a2e49dcdc2e/meta\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73783498-4b8f-483d-b8d6-4de2d109d6bb", "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", "zones", ":zone_id", "meta" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"S1033\",\n \"message\": \"Restricted zone\",\n \"space_id\": \"3009000000789069\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000789069/zones/e42f51ec-e4dc-4dc5-9587-7a2e49dcdc2e/meta\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abcd976c-ebd5-4439-890f-1d8f0230921b", "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", "zones", ":zone_id", "meta" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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": "6450a66b-619b-4cb1-bbe1-ff31f294c8cc", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "meta" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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": "0934cddf-32fa-4c39-bbd7-28d69c4f0e28", "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", "zones", ":zone_id", "meta" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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": "9d271339-ebbe-451f-9d14-47a462f9230c", "name": "Update zone metadata", "request": { "name": "Update zone metadata", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "meta" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"zone_name\": \"ᦏ㎦㣕淑\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7657babf-0e22-4308-ba6d-a94f6db8880f", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "meta" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"zone_name\": \"ᦏ㎦㣕淑\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"zone_id\": \"598356E6-5F86-45FA-A7D5-ED8BB6D40DAE\",\n \"edition_id\": \"97375109\",\n \"current_user_id\": \"96384499\",\n \"space_id\": \"1505000000022005\",\n \"new_name\": \"Budget Report\"\n },\n \"message\": \"Zone name updated successfully.\",\n \"request_uri\": \"/vani/api/v1/editions/97375109/spaces/1505000000022005/zones/598356E6-5F86-45FA-A7D5-ED8BB6D40DAE/meta\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c32c4e5-1ff2-4e0b-9ce6-54de07a5ac82", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "meta" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"zone_name\": \"ᦏ㎦㣕淑\"\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": "7d5531f7-bbf8-4b7a-ba6f-f3b958a3a697", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "meta" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"zone_name\": \"ᦏ㎦㣕淑\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"zone_id\": \"a5fcca17-e9dd-414f-850d-0b920645b05d\",\n \"edition_id\": \"98723605\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"5265000000003011\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/98723605/spaces/5265000000003011/zones/a5fcca17-e9dd-414f-850d-0b920645b05d/meta\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8834436-c7d0-4e3c-b3c5-4f6444df3bae", "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", "zones", ":zone_id", "meta" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"zone_name\": \"ᦏ㎦㣕淑\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"zone_id\": \"198356E6-5F86-45FA-A7D5-ED8BB6D40DAE\",\n \"edition_id\": \"97375109\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"1505000000022005\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/97375109/spaces/1505000000022005/zones/198356E6-5F86-45FA-A7D5-ED8BB6D40DAE/meta\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1231eae-6589-4b15-a478-f72a0d9c4893", "name": "Conflict - the requested change conflicts with the current resource state", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "meta" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"zone_name\": \"ᦏ㎦㣕淑\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"zone_id\": \"598356E6-5F86-45FA-A7D5-ED8BB6D40DAE\",\n \"edition_id\": \"97375109\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"Z1001\",\n \"message\": \"Zone name is same as the new name\",\n \"space_id\": \"1505000000022005\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/97375109/spaces/1505000000022005/zones/598356E6-5F86-45FA-A7D5-ED8BB6D40DAE/meta\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40ef16b6-56a3-41d2-8fa3-2b8c78d7c13c", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "meta" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"zone_name\": \"ᦏ㎦㣕淑\"\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": "b6f01985-8a17-44ed-845e-4893d2e6930d", "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", "zones", ":zone_id", "meta" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"zone_name\": \"ᦏ㎦㣕淑\"\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": "e495b67e-c102-476f-8977-87ae01101d47", "name": "Insert a template into a zone", "request": { "name": "Insert a template into a zone", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "templates" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"template_id\": \"340608\",\n \"placement\": \"AUTO\",\n \"position\": {\n \"top\": 9193.524311443196,\n \"left\": 5234.059341861501\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2fbe9c08-2beb-496d-bedc-d52a5d113174", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "templates" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"template_id\": \"340608\",\n \"placement\": \"AUTO\",\n \"position\": {\n \"top\": 9193.524311443196,\n \"left\": 5234.059341861501\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b8babdf-6f26-4ff2-9f46-788fffe8fa0d", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "templates" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"template_id\": \"340608\",\n \"placement\": \"AUTO\",\n \"position\": {\n \"top\": 9193.524311443196,\n \"left\": 5234.059341861501\n }\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": "8b08df5c-ae4b-48ec-ae0e-a0b21549313a", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "templates" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"template_id\": \"340608\",\n \"placement\": \"AUTO\",\n \"position\": {\n \"top\": 9193.524311443196,\n \"left\": 5234.059341861501\n }\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": "c601cb61-98ab-4898-b925-dbe833a9aa4f", "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", "zones", ":zone_id", "templates" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"template_id\": \"340608\",\n \"placement\": \"AUTO\",\n \"position\": {\n \"top\": 9193.524311443196,\n \"left\": 5234.059341861501\n }\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": "3dde8c25-1ff3-473e-80b4-38fcc061ab7c", "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", "zones", ":zone_id", "templates" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"template_id\": \"340608\",\n \"placement\": \"AUTO\",\n \"position\": {\n \"top\": 9193.524311443196,\n \"left\": 5234.059341861501\n }\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": "3404d37f-dad3-4718-9a63-c54b17fc71e2", "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", "zones", ":zone_id", "templates" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"template_id\": \"340608\",\n \"placement\": \"AUTO\",\n \"position\": {\n \"top\": 9193.524311443196,\n \"left\": 5234.059341861501\n }\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": "36c43d8f-4d63-4af5-8f91-703c8681a98b", "name": "Update zone state", "request": { "name": "Update zone state", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "state" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"zone_state\": \"DELETE\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7558400b-1b63-42c6-bc90-e4899d84dfed", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "state" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"zone_state\": \"DELETE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"zone_id\": \"598356E6-5F86-45FA-A7D5-ED8BB6D40DAE\",\n \"edition_id\": \"97375109\",\n \"space_state\": \"TRASH\",\n \"current_user_id\": \"96384499\",\n \"space_id\": \"1505000000022005\"\n },\n \"message\": \"Zone state updated successfully.\",\n \"request_uri\": \"/vani/api/v1/editions/97375109/spaces/1505000000022005/zones/598356E6-5F86-45FA-A7D5-ED8BB6D40DAE/state\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6755db8a-af55-428b-8421-f25d5d8a94f8", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "state" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"zone_state\": \"DELETE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"zone_id\": \"6F961124-4598-47D6-9BDA-1705DFBA07D7\",\n \"edition_id\": \"97375109\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"Z1009\",\n \"message\": \"Zone threshold violation\",\n \"space_id\": \"1505000000022005\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/97375109/spaces/1505000000022005/zones/6F961124-4598-47D6-9BDA-1705DFBA07D7/state\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a8ed542-62e4-4516-9ce7-eb79b684441b", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "state" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"zone_state\": \"DELETE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"zone_id\": \"05A61516-A352-44C6-94C3-BE44F728C9D9\",\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"300900000009397\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/300900000009397/zones/05A61516-A352-44C6-94C3-BE44F728C9D9/state\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13b97775-08ff-400e-9dec-30ff3aa22c3a", "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", "zones", ":zone_id", "state" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"zone_state\": \"DELETE\"\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": "6e20f2a4-c0a3-4981-9afd-12b17b187118", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "state" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"zone_state\": \"DELETE\"\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": "9d5b92d8-acd6-401e-9196-83bf1001e8ef", "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", "zones", ":zone_id", "state" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"zone_state\": \"DELETE\"\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": "78261288-c051-4923-b32d-3dde0cd698d0", "name": "Get metadata for all zones in a space", "request": { "name": "Get metadata for all zones in a space", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "meta" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "author_zuid", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: created_time, last_modified_time, zone_name, author_zuid, status, last_author_zuid, space_id, state_modified_time" } ], "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": "145b3123-8c1a-4823-ad04-0ff98c9cde58", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "meta" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "author_zuid" } ], "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 \"zones_info\": {\n \"zone_order\": [\n \"0e1e3a8a-a115-463e-bdb6-f540ab37eeb6\",\n \"6F961124-4598-47D6-9BDA-1705DFBA07D7\",\n \"598356E6-5F86-45FA-A7D5-ED8BB6D40DAE\"\n ],\n \"zone_meta\": {\n \"598356E6-5F86-45FA-A7D5-ED8BB6D40DAE\": {\n \"created_time\": \"Tue, 04 Feb 2025, 11:34:28\",\n \"zone_name\": \"Zone 3\"\n },\n \"0e1e3a8a-a115-463e-bdb6-f540ab37eeb6\": {\n \"created_time\": \"Tue, 28 Jan 2025, 11:59:50\",\n \"zone_name\": \"Zone 1\"\n },\n \"6F961124-4598-47D6-9BDA-1705DFBA07D7\": {\n \"created_time\": \"Tue, 04 Feb 2025, 11:34:26\",\n \"zone_name\": \"Zone 2\"\n }\n }\n }\n },\n \"message\": \"Zone metadata fetched successfully.\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000095397/zones/meta\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcdd75fb-d0ea-4e08-9f81-065a62d28ef5", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "meta" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "author_zuid" } ], "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 \"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": "6f224fb9-2aed-4cdb-bc0a-0fc0a2912354", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "meta" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "author_zuid" } ], "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\": \"97375109\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"1505000000022005\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/97375109/spaces/1505000000022005/zones/meta\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "959becfa-a958-40ff-ac0a-cd30e74976d4", "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", "zones", "meta" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "author_zuid" } ], "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ccdb301-62ad-4519-b84d-6375e7230d7f", "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", "zones", "meta" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "author_zuid" } ], "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e147c548-f8e9-4e00-976d-eb055e8c7339", "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", "zones", "meta" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "author_zuid" } ], "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 }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a30d8414-a862-4a80-aaf7-52601ff060d8", "name": "Duplicate a zone", "request": { "name": "Duplicate a zone", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "duplicate" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"duplicate_zone\": {\n \"destination_type\": \"EXISTING_SPACE\",\n \"space_name\": \"㚬櫀ষ梥閣㔈ბ₠䒓\",\n \"deep_copy\": true,\n \"zone_name\": \"쿣ͬꅬ僌\",\n \"version_id\": \"string\",\n \"team_id\": \"string\",\n \"copy_members\": true,\n \"destination_space_id\": \"string\",\n \"copy_comments\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "70709da2-61cf-456a-bf10-a0db2d01e5a6", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "duplicate" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"duplicate_zone\": {\n \"destination_type\": \"EXISTING_SPACE\",\n \"space_name\": \"㚬櫀ষ梥閣㔈ბ₠䒓\",\n \"deep_copy\": true,\n \"zone_name\": \"쿣ͬꅬ僌\",\n \"version_id\": \"string\",\n \"team_id\": \"string\",\n \"copy_members\": true,\n \"destination_space_id\": \"string\",\n \"copy_comments\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"space_id\": \"693000000598369\",\n \"uri\": \"/vani/api/v1/editions/75918186/spaces/693000000598369/zones/meta\"\n },\n \"message\": \"Zone duplicated successfully\",\n \"request_uri\": \"/vani/api/v1/editions/75918186/spaces/693000000562161/zones/8915a5e7-ba1a-4ef9-8f25-75a873ff7f10/duplicate\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53ae9c9d-5bec-41d1-9d0b-79fd37b3a347", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "duplicate" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"duplicate_zone\": {\n \"destination_type\": \"EXISTING_SPACE\",\n \"space_name\": \"㚬櫀ষ梥閣㔈ბ₠䒓\",\n \"deep_copy\": true,\n \"zone_name\": \"쿣ͬꅬ僌\",\n \"version_id\": \"string\",\n \"team_id\": \"string\",\n \"copy_members\": true,\n \"destination_space_id\": \"string\",\n \"copy_comments\": true\n }\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": "4688d083-e064-4b69-a3bc-87c9abe68f38", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "duplicate" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"duplicate_zone\": {\n \"destination_type\": \"EXISTING_SPACE\",\n \"space_name\": \"㚬櫀ষ梥閣㔈ბ₠䒓\",\n \"deep_copy\": true,\n \"zone_name\": \"쿣ͬꅬ僌\",\n \"version_id\": \"string\",\n \"team_id\": \"string\",\n \"copy_members\": true,\n \"destination_space_id\": \"string\",\n \"copy_comments\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"75918186\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"69300000562248\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/75918186/spaces/69300000562248/zones/91c26965-0165-4b48-b976-16c924498a8c/duplicate\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d60b253-1732-4677-ae2e-c4805f93135f", "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", "zones", ":zone_id", "duplicate" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"duplicate_zone\": {\n \"destination_type\": \"EXISTING_SPACE\",\n \"space_name\": \"㚬櫀ষ梥閣㔈ბ₠䒓\",\n \"deep_copy\": true,\n \"zone_name\": \"쿣ͬꅬ僌\",\n \"version_id\": \"string\",\n \"team_id\": \"string\",\n \"copy_members\": true,\n \"destination_space_id\": \"string\",\n \"copy_comments\": true\n }\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\": \"75918186\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"693000000562248\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/75918186/spaces/693000000562248/zones/11c26965-0165-4b48-b976-16c924498a8c/duplicate\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9695fb9-2846-449d-9813-de8041426d72", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "duplicate" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"duplicate_zone\": {\n \"destination_type\": \"EXISTING_SPACE\",\n \"space_name\": \"㚬櫀ষ梥閣㔈ბ₠䒓\",\n \"deep_copy\": true,\n \"zone_name\": \"쿣ͬꅬ僌\",\n \"version_id\": \"string\",\n \"team_id\": \"string\",\n \"copy_members\": true,\n \"destination_space_id\": \"string\",\n \"copy_comments\": true\n }\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": "2eba48a3-922e-46d4-919c-1baef78a8466", "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", "zones", ":zone_id", "duplicate" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"duplicate_zone\": {\n \"destination_type\": \"EXISTING_SPACE\",\n \"space_name\": \"㚬櫀ষ梥閣㔈ბ₠䒓\",\n \"deep_copy\": true,\n \"zone_name\": \"쿣ͬꅬ僌\",\n \"version_id\": \"string\",\n \"team_id\": \"string\",\n \"copy_members\": true,\n \"destination_space_id\": \"string\",\n \"copy_comments\": true\n }\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 } } ], "event": [] }, { "id": "471e2762-5da3-447b-ad48-f6be2aa2da4f", "name": "Zone Versions", "description": { "content": "Read the current version of a zone.", "type": "text/plain" }, "item": [ { "id": "f4b65564-480e-4ce6-b230-61a04d54700d", "name": "Get the current version of a zone", "request": { "name": "Get the current version of a zone", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "version" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "uri", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: modified_by, version_id, version_time, description, uri" }, { "disabled": false, "key": "from", "value": "06623", "description": "The starting index from where the results should be fetched. Default value is 0" }, { "disabled": false, "key": "limit", "value": "927", "description": "The maximum number of results to return in the response. Default value is 20" }, { "disabled": false, "key": "from_date", "value": "string", "description": "Allows you to fetch only those Zone versions that have been created or modified since the given timestamp" } ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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": "773a9801-127e-4173-becd-2189bb745f46", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "uri" }, { "key": "from", "value": "06623" }, { "key": "limit", "value": "927" }, { "key": "from_date", "value": "string" } ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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 \"zone_versions\": {\n \"restricted_versions\": [\n {\n \"modified_by\": \"80215739\",\n \"version_id\": \"1373000000529563\"\n }\n ],\n \"allowed_versions\": []\n }\n },\n \"message\": \"Zone versions fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/80585907/spaces/1373000000529203/zones/1b28dc96-a3bc-45c3-9977-e4089b513a31/version\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "747fffb2-2b61-4498-8af2-bc2f92df19b4", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "uri" }, { "key": "from", "value": "06623" }, { "key": "limit", "value": "927" }, { "key": "from_date", "value": "string" } ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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": "dae62d8a-cf10-4fde-ae4c-985a188365ea", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "uri" }, { "key": "from", "value": "06623" }, { "key": "limit", "value": "927" }, { "key": "from_date", "value": "string" } ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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\": \"85572652\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"160000000657005\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/85572652/spaces/160000000657005/zones/ef7b7fe1-327b-4ec1-904d-8232677d689c/version\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d14f2a67-3d73-4c79-be4b-b98942001f6a", "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", "zones", ":zone_id", "version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "uri" }, { "key": "from", "value": "06623" }, { "key": "limit", "value": "927" }, { "key": "from_date", "value": "string" } ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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\": \"75434908\",\n \"current_user_id\": \"80215739\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"149000042348078\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/75434908/spaces/149000042348078/zones/89cf103a-0701-41b3-823c-f2229436333e/version\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08ceb4c5-43d4-40c5-87ff-5692f74a0b9c", "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", "zones", ":zone_id", "version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "uri" }, { "key": "from", "value": "06623" }, { "key": "limit", "value": "927" }, { "key": "from_date", "value": "string" } ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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": "d647a781-7276-4f61-9927-12b1c0b2227c", "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", "zones", ":zone_id", "version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "uri" }, { "key": "from", "value": "06623" }, { "key": "limit", "value": "927" }, { "key": "from_date", "value": "string" } ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "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": "d5351ad6-2a91-4680-8c5c-9c7151a18d9a", "name": "Conditional Sharing", "description": { "content": "Share individual zones within a space with a specific member.", "type": "text/plain" }, "item": [ { "id": "11f7cb49-bb46-4f4b-a2a1-955d4586d06e", "name": "Share zones in a space with members", "request": { "name": "Share zones in a space with members", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members" ], "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 \"members_info\": [\n {\n \"member_id\": \"string\",\n \"member_type\": \"ORG\",\n \"resource_id\": \"1C22ee0d-e2e9-7E51-eb27-E2dC0330F413\",\n \"role\": \"VIEWER\",\n \"permission\": \"restricted\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b15f1b8e-3541-421a-a429-3ed7659234fb", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members" ], "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 \"members_info\": [\n {\n \"member_id\": \"string\",\n \"member_type\": \"ORG\",\n \"resource_id\": \"1C22ee0d-e2e9-7E51-eb27-E2dC0330F413\",\n \"role\": \"VIEWER\",\n \"permission\": \"restricted\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"added_members\": [\n {\n \"member_id\": \"3009000000002003\",\n \"access_state\": \"PARTIAL ACCESS\",\n \"resources\": [\n {\n \"member_type\": \"TEAM\",\n \"added_time\": \"Tue, 08 Jul 2025, 01:58:52\",\n \"added_by\": \"96384499\",\n \"resource_type\": \"document\",\n \"resource_id\": \"6800EB6E-ED24-4EA6-91C6-805445418B17\",\n \"permission\": \"restricted\"\n }\n ]\n },\n {\n \"member_id\": \"62609972\",\n \"access_state\": \"PARTIAL ACCESS\",\n \"resources\": [\n {\n \"member_type\": \"USER\",\n \"added_time\": \"Mon, 07 Jul 2025, 18:16:32\",\n \"added_by\": \"80215739\",\n \"resource_type\": \"document\",\n \"resource_id\": \"6800EB6E-ED24-4EA6-91C6-805445418B17\",\n \"permission\": \"restricted\"\n }\n ]\n }\n ]\n },\n \"message\": \"Resource members added successfully\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffe6b56e-a226-4307-8b8f-118008b3187c", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members" ], "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 \"members_info\": [\n {\n \"member_id\": \"string\",\n \"member_type\": \"ORG\",\n \"resource_id\": \"1C22ee0d-e2e9-7E51-eb27-E2dC0330F413\",\n \"role\": \"VIEWER\",\n \"permission\": \"restricted\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Partial Content", "code": 206, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"failed_members\": [\n {\n \"error_message\": \"Resource member present\",\n \"error_code\": \"S1042\",\n \"zuid\": \"3009000000002003\"\n }\n ],\n \"added_members\": [\n {\n \"member_id\": \"85572741\",\n \"access_state\": \"PARTIAL ACCESS\",\n \"resources\": [\n {\n \"member_type\": \"USER\",\n \"added_time\": \"Wed, 09 Jul 2025, 15:52:18\",\n \"added_by\": \"96384499\",\n \"resource_type\": \"document\",\n \"resource_id\": \"d7ccf816-8293-4a2f-ae83-f10c0e3a6645\",\n \"permission\": \"restricted\"\n }\n ]\n }\n ]\n },\n \"message\": \"Partial success: Some resource members added, others failed.\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "081f8d8a-bac7-4182-b900-efbff86a8223", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members" ], "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 \"members_info\": [\n {\n \"member_id\": \"string\",\n \"member_type\": \"ORG\",\n \"resource_id\": \"1C22ee0d-e2e9-7E51-eb27-E2dC0330F413\",\n \"role\": \"VIEWER\",\n \"permission\": \"restricted\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"failed_members\": [\n {\n \"error_message\": \"Resource member present\",\n \"error_code\": \"S1042\",\n \"zuid\": \"3009000000002003\"\n },\n {\n \"error_message\": \"Resource member present\",\n \"error_code\": \"S1042\",\n \"zuid\": \"3009000000002003\"\n }\n ],\n \"error_code\": \"R1002\",\n \"message\": \"Resource member add failed\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e7e7cbf-1a19-41d8-aecf-aa85148eb21a", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members" ], "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 \"members_info\": [\n {\n \"member_id\": \"string\",\n \"member_type\": \"ORG\",\n \"resource_id\": \"1C22ee0d-e2e9-7E51-eb27-E2dC0330F413\",\n \"role\": \"VIEWER\",\n \"permission\": \"restricted\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"3009000000607005\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000607005/zones/members\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5628a41-4db1-408e-9cb3-e7dff4b49f79", "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", "zones", "members" ], "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 \"members_info\": [\n {\n \"member_id\": \"string\",\n \"member_type\": \"ORG\",\n \"resource_id\": \"1C22ee0d-e2e9-7E51-eb27-E2dC0330F413\",\n \"role\": \"VIEWER\",\n \"permission\": \"restricted\"\n }\n ]\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\": \"300900000618005\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/300900000618005/zones/members\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c1f9a3d-dc39-4482-9161-25875a2fbb5f", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members" ], "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 \"members_info\": [\n {\n \"member_id\": \"string\",\n \"member_type\": \"ORG\",\n \"resource_id\": \"1C22ee0d-e2e9-7E51-eb27-E2dC0330F413\",\n \"role\": \"VIEWER\",\n \"permission\": \"restricted\"\n }\n ]\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": "0449ec82-dc47-429c-9626-dc99d51859e1", "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", "zones", "members" ], "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 \"members_info\": [\n {\n \"member_id\": \"string\",\n \"member_type\": \"ORG\",\n \"resource_id\": \"1C22ee0d-e2e9-7E51-eb27-E2dC0330F413\",\n \"role\": \"VIEWER\",\n \"permission\": \"restricted\"\n }\n ]\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": "ea1c4de5-4f78-4507-9e05-536ba8c7a4a4", "name": "Share every zone in a space with a member", "request": { "name": "Share every zone in a space with a member", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members", ":member_id" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "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": "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" } ] } }, "response": [ { "id": "b6a36e5e-cc6e-423a-8335-e152b36fb1b8", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members", ":member_id" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "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": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"space_resource_info\": {\n \"member_id\": \"3009000000002003\",\n \"access_state\": \"FULL ACCESS\",\n \"resources\": [\n {\n \"member_type\": \"TEAM\",\n \"added_time\": \"Mon, 07 Jul 2025, 18:22:20\",\n \"added_by\": \"80215739\",\n \"resource_type\": \"document\",\n \"resource_id\": \"d7ccf816-8293-4a2f-ae83-f10c0e3a6645\",\n \"permission\": \"allowed\"\n },\n {\n \"member_type\": \"TEAM\",\n \"added_time\": \"Mon, 07 Jul 2025, 18:22:20\",\n \"added_by\": \"80215739\",\n \"resource_type\": \"document\",\n \"resource_id\": \"31E57A34-3405-41D2-A2B6-7BAACAE9EE02\",\n \"permission\": \"allowed\"\n },\n {\n \"member_type\": \"TEAM\",\n \"added_time\": \"Mon, 07 Jul 2025, 18:22:20\",\n \"added_by\": \"80215739\",\n \"resource_type\": \"document\",\n \"resource_id\": \"9E23791B-B3AE-4877-9119-3F636DC685AC\",\n \"permission\": \"allowed\"\n },\n {\n \"member_type\": \"TEAM\",\n \"added_time\": \"Mon, 07 Jul 2025, 18:22:08\",\n \"added_by\": \"80215739\",\n \"resource_type\": \"document\",\n \"resource_id\": \"6800EB6E-ED24-4EA6-91C6-805445418B17\",\n \"permission\": \"allowed\"\n }\n ],\n \"space_id\": \"3009000000618005\"\n }\n },\n \"message\": \"All resources shared successfully\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members/3009000000002003\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b555978a-ea23-4197-895f-3da9a5ace332", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members", ":member_id" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "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": {} }, "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": "d3505672-b1e9-4bcd-a2df-0cc08aba62a8", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members", ":member_id" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "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": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"3009000000612023\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000612023/zones/members/3009000000002004\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6fbbebb-7953-45a6-893d-747ba5ceb349", "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", "zones", "members", ":member_id" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "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": {} }, "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\": \"S1015\",\n \"message\": \"member is not part of the Space\",\n \"space_id\": \"3009000000618005\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members/3009000000002004\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12329da1-8904-4ba7-8ac0-6be4c09fb8a4", "name": "Conflict - the requested change conflicts with the current resource state", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members", ":member_id" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "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": {} }, "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\": \"S1045\",\n \"message\": \"Member already has full access\",\n \"space_id\": \"3009000000618005\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members/3009000000002003\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d12998b0-e435-476a-8d8d-9c78f5e2f837", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members", ":member_id" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "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": {} }, "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": "1bea7830-a351-45aa-b285-ebd9a2b3ed9d", "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", "zones", "members", ":member_id" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "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": {} }, "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": "c41bdbcd-387a-4a94-be05-558a80b2b8c1", "name": "Get the zones in a space shared with a member", "request": { "name": "Get the zones in a space shared with a member", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members", ":member_id" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "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": "3a89cb26-3883-49f5-9591-8e40cad72f75", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members", ":member_id" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "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 \"space_resource_info\": {\n \"member_id\": \"96384499\",\n \"access_state\": \"FULL ACCESS\",\n \"resources\": [],\n \"space_id\": \"3009000000618005\"\n }\n },\n \"message\": \"User resources fetched successfully.\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members/96384499\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adf2536e-85e0-4171-b62c-e906de04a123", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members", ":member_id" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "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": "74dca1d1-0dbb-4a37-8679-2424a24dbe6c", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members", ":member_id" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "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 \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"3009000000612023\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000612023/zones/members/9638449\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6eda49b7-14f5-4d26-a004-a9e3b1227cf9", "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", "zones", "members", ":member_id" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "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\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"S1015\",\n \"message\": \"member is not part of the Space\",\n \"space_id\": \"3009000000618005\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members/9638449\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45f03ba6-e6ed-4753-9d07-223b36d348c5", "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", "zones", "members", ":member_id" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "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": "cd943234-facb-4f68-85a7-3d19359cf8e6", "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", "zones", "members", ":member_id" ], "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" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "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": "f47f42fe-fb59-4dae-9a7c-98adcf619f54", "name": "Zones", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Zones (documents) within a space: lifecycle, metadata, versioning, and per-zone sharing." } }