{ "item": [ { "id": "ab85d976-e348-43ab-87e5-6f2c46aebea6", "name": "Text", "description": { "content": "Mutate and style text on any text-bearing object.", "type": "text/plain" }, "item": [ { "id": "366081d9-5e44-4e35-a56a-03c03fcc70b1", "name": "Canonical text mutation API for replace/insert/delete/split/merge operations", "request": { "name": "Canonical text mutation API for replace/insert/delete/split/merge operations", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", "edit" ], "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 \"object\": {\n \"zone_id\": \"c1D1e5f7-f3bE-a558-35C6-664a2C6F4b7B\",\n \"object_id\": \"7b7a7F69-eAfE-C90d-31B4-be44228e9fCE\",\n \"frame_id\": \"ee11Feee-f76E-7a97-947A-2bd4027250bD\"\n },\n \"payload\": {\n \"cursor\": {\n \"cursor_index\": 7657,\n \"operation\": \"CURSOR_TEXT_OPERATION_UNSPECIFIED\",\n \"text\": \"\\ud8b8拓鉑U孲—\"\n },\n \"all_text\": {\n \"operation\": \"ALL_TEXT_OPERATION_UNSPECIFIED\",\n \"replacement_text\": \"빲撽\"\n },\n \"range\": {\n \"range\": {\n \"start_index\": 765,\n \"end_index\": 5645\n },\n \"operation\": \"RANGE_TEXT_OPERATION_REPLACE\",\n \"replacement_text\": \"쏡\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6f87ee41-566c-407b-aabf-a8bbd8272c34", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", "edit" ], "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 \"object\": {\n \"zone_id\": \"c1D1e5f7-f3bE-a558-35C6-664a2C6F4b7B\",\n \"object_id\": \"7b7a7F69-eAfE-C90d-31B4-be44228e9fCE\",\n \"frame_id\": \"ee11Feee-f76E-7a97-947A-2bd4027250bD\"\n },\n \"payload\": {\n \"cursor\": {\n \"cursor_index\": 7657,\n \"operation\": \"CURSOR_TEXT_OPERATION_UNSPECIFIED\",\n \"text\": \"\\ud8b8拓鉑U孲—\"\n },\n \"all_text\": {\n \"operation\": \"ALL_TEXT_OPERATION_UNSPECIFIED\",\n \"replacement_text\": \"빲撽\"\n },\n \"range\": {\n \"range\": {\n \"start_index\": 765,\n \"end_index\": 5645\n },\n \"operation\": \"RANGE_TEXT_OPERATION_REPLACE\",\n \"replacement_text\": \"쏡\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {\n \"result\": {\n \"applied_range\": {\n \"start_index\": \"string\",\n \"end_index\": \"string\"\n }\n },\n \"mutation\": {\n \"new_revision_id\": \"string\"\n },\n \"error\": {\n \"code\": \"OBJECT_NOT_FOUND\",\n \"message\": \"string\"\n },\n \"object\": {\n \"zone_id\": \"string\",\n \"object_id\": \"string\",\n \"frame_id\": \"string\"\n }\n },\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e0ce9c2-6954-40ca-b009-d874fed54315", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", "edit" ], "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 \"object\": {\n \"zone_id\": \"c1D1e5f7-f3bE-a558-35C6-664a2C6F4b7B\",\n \"object_id\": \"7b7a7F69-eAfE-C90d-31B4-be44228e9fCE\",\n \"frame_id\": \"ee11Feee-f76E-7a97-947A-2bd4027250bD\"\n },\n \"payload\": {\n \"cursor\": {\n \"cursor_index\": 7657,\n \"operation\": \"CURSOR_TEXT_OPERATION_UNSPECIFIED\",\n \"text\": \"\\ud8b8拓鉑U孲—\"\n },\n \"all_text\": {\n \"operation\": \"ALL_TEXT_OPERATION_UNSPECIFIED\",\n \"replacement_text\": \"빲撽\"\n },\n \"range\": {\n \"range\": {\n \"start_index\": 765,\n \"end_index\": 5645\n },\n \"operation\": \"RANGE_TEXT_OPERATION_REPLACE\",\n \"replacement_text\": \"쏡\"\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 \"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": "db0e8077-09ce-4737-b3e1-7fc3564601bb", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", "edit" ], "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 \"object\": {\n \"zone_id\": \"c1D1e5f7-f3bE-a558-35C6-664a2C6F4b7B\",\n \"object_id\": \"7b7a7F69-eAfE-C90d-31B4-be44228e9fCE\",\n \"frame_id\": \"ee11Feee-f76E-7a97-947A-2bd4027250bD\"\n },\n \"payload\": {\n \"cursor\": {\n \"cursor_index\": 7657,\n \"operation\": \"CURSOR_TEXT_OPERATION_UNSPECIFIED\",\n \"text\": \"\\ud8b8拓鉑U孲—\"\n },\n \"all_text\": {\n \"operation\": \"ALL_TEXT_OPERATION_UNSPECIFIED\",\n \"replacement_text\": \"빲撽\"\n },\n \"range\": {\n \"range\": {\n \"start_index\": 765,\n \"end_index\": 5645\n },\n \"operation\": \"RANGE_TEXT_OPERATION_REPLACE\",\n \"replacement_text\": \"쏡\"\n }\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": "4a8cd119-48fd-4a47-b1da-06b9aab25e2b", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", "edit" ], "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 \"object\": {\n \"zone_id\": \"c1D1e5f7-f3bE-a558-35C6-664a2C6F4b7B\",\n \"object_id\": \"7b7a7F69-eAfE-C90d-31B4-be44228e9fCE\",\n \"frame_id\": \"ee11Feee-f76E-7a97-947A-2bd4027250bD\"\n },\n \"payload\": {\n \"cursor\": {\n \"cursor_index\": 7657,\n \"operation\": \"CURSOR_TEXT_OPERATION_UNSPECIFIED\",\n \"text\": \"\\ud8b8拓鉑U孲—\"\n },\n \"all_text\": {\n \"operation\": \"ALL_TEXT_OPERATION_UNSPECIFIED\",\n \"replacement_text\": \"빲撽\"\n },\n \"range\": {\n \"range\": {\n \"start_index\": 765,\n \"end_index\": 5645\n },\n \"operation\": \"RANGE_TEXT_OPERATION_REPLACE\",\n \"replacement_text\": \"쏡\"\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 \"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": "093987b0-7b5a-4782-9c01-a8e5e95e1283", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", "edit" ], "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 \"object\": {\n \"zone_id\": \"c1D1e5f7-f3bE-a558-35C6-664a2C6F4b7B\",\n \"object_id\": \"7b7a7F69-eAfE-C90d-31B4-be44228e9fCE\",\n \"frame_id\": \"ee11Feee-f76E-7a97-947A-2bd4027250bD\"\n },\n \"payload\": {\n \"cursor\": {\n \"cursor_index\": 7657,\n \"operation\": \"CURSOR_TEXT_OPERATION_UNSPECIFIED\",\n \"text\": \"\\ud8b8拓鉑U孲—\"\n },\n \"all_text\": {\n \"operation\": \"ALL_TEXT_OPERATION_UNSPECIFIED\",\n \"replacement_text\": \"빲撽\"\n },\n \"range\": {\n \"range\": {\n \"start_index\": 765,\n \"end_index\": 5645\n },\n \"operation\": \"RANGE_TEXT_OPERATION_REPLACE\",\n \"replacement_text\": \"쏡\"\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": "ec287737-5c20-4319-ba95-912a4e721892", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", "edit" ], "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 \"object\": {\n \"zone_id\": \"c1D1e5f7-f3bE-a558-35C6-664a2C6F4b7B\",\n \"object_id\": \"7b7a7F69-eAfE-C90d-31B4-be44228e9fCE\",\n \"frame_id\": \"ee11Feee-f76E-7a97-947A-2bd4027250bD\"\n },\n \"payload\": {\n \"cursor\": {\n \"cursor_index\": 7657,\n \"operation\": \"CURSOR_TEXT_OPERATION_UNSPECIFIED\",\n \"text\": \"\\ud8b8拓鉑U孲—\"\n },\n \"all_text\": {\n \"operation\": \"ALL_TEXT_OPERATION_UNSPECIFIED\",\n \"replacement_text\": \"빲撽\"\n },\n \"range\": {\n \"range\": {\n \"start_index\": 765,\n \"end_index\": 5645\n },\n \"operation\": \"RANGE_TEXT_OPERATION_REPLACE\",\n \"replacement_text\": \"쏡\"\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": "a47f8144-13a9-4df9-895d-df5d5d5f8073", "name": "Apply portion and or paragraph style to selected text scope", "request": { "name": "Apply portion and or paragraph style to selected text scope", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", "style" ], "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 \"object\": {\n \"zone_id\": \"bC755CC4-6EBF-8ADF-37eb-cb96144F9a9c\",\n \"object_id\": \"bEf4E370-Cd85-c5B8-cDcC-339dc9E68b27\",\n \"frame_id\": \"f0a692D9-Cf68-0c8d-0384-eCa41bC70C6c\"\n },\n \"payload\": {\n \"all_text\": true,\n \"portion_style\": {\n \"fontweight\": \"MEDIUM\",\n \"size\": 3638.390129193547,\n \"color\": {\n \"hsb\": {\n \"saturation\": 2508.482434141348,\n \"brightness\": 5560.8753275157105,\n \"hue\": 7915.3544130535565\n },\n \"hex\": {\n \"value\": \"bFbAe819\"\n },\n \"rgb\": {\n \"red\": 9145,\n \"green\": 4381,\n \"blue\": 7431\n }\n },\n \"underline\": false,\n \"strike\": false,\n \"italic\": false,\n \"font_name\": {\n \"name\": \"ੵ곊西킜劷ᘱ瀄\",\n \"style\": \"VL8Eu\"\n }\n },\n \"range\": {\n \"start_index\": 1725,\n \"end_index\": 4603\n },\n \"paragraph_style\": {\n \"spacing\": {\n \"before\": 7522,\n \"line\": 90.12815991418677,\n \"after\": 5674\n },\n \"level\": 7170,\n \"halign\": \"CENTER\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5a4007fa-b7a1-4fec-aaea-db3486d100d9", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", "style" ], "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 \"object\": {\n \"zone_id\": \"bC755CC4-6EBF-8ADF-37eb-cb96144F9a9c\",\n \"object_id\": \"bEf4E370-Cd85-c5B8-cDcC-339dc9E68b27\",\n \"frame_id\": \"f0a692D9-Cf68-0c8d-0384-eCa41bC70C6c\"\n },\n \"payload\": {\n \"all_text\": true,\n \"portion_style\": {\n \"fontweight\": \"MEDIUM\",\n \"size\": 3638.390129193547,\n \"color\": {\n \"hsb\": {\n \"saturation\": 2508.482434141348,\n \"brightness\": 5560.8753275157105,\n \"hue\": 7915.3544130535565\n },\n \"hex\": {\n \"value\": \"bFbAe819\"\n },\n \"rgb\": {\n \"red\": 9145,\n \"green\": 4381,\n \"blue\": 7431\n }\n },\n \"underline\": false,\n \"strike\": false,\n \"italic\": false,\n \"font_name\": {\n \"name\": \"ੵ곊西킜劷ᘱ瀄\",\n \"style\": \"VL8Eu\"\n }\n },\n \"range\": {\n \"start_index\": 1725,\n \"end_index\": 4603\n },\n \"paragraph_style\": {\n \"spacing\": {\n \"before\": 7522,\n \"line\": 90.12815991418677,\n \"after\": 5674\n },\n \"level\": 7170,\n \"halign\": \"CENTER\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {\n \"result\": {\n \"affected_paragraph_count\": \"string\",\n \"affected_portion_count\": \"string\"\n },\n \"mutation\": {\n \"new_revision_id\": \"string\"\n },\n \"error\": {\n \"code\": \"AGENT_ERROR_CODE_UNSPECIFIED\",\n \"message\": \"string\"\n },\n \"object\": {\n \"zone_id\": \"string\",\n \"object_id\": \"string\",\n \"frame_id\": \"string\"\n }\n },\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4a98fe8-c900-4d6b-9cd0-891bba6c7f44", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", "style" ], "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 \"object\": {\n \"zone_id\": \"bC755CC4-6EBF-8ADF-37eb-cb96144F9a9c\",\n \"object_id\": \"bEf4E370-Cd85-c5B8-cDcC-339dc9E68b27\",\n \"frame_id\": \"f0a692D9-Cf68-0c8d-0384-eCa41bC70C6c\"\n },\n \"payload\": {\n \"all_text\": true,\n \"portion_style\": {\n \"fontweight\": \"MEDIUM\",\n \"size\": 3638.390129193547,\n \"color\": {\n \"hsb\": {\n \"saturation\": 2508.482434141348,\n \"brightness\": 5560.8753275157105,\n \"hue\": 7915.3544130535565\n },\n \"hex\": {\n \"value\": \"bFbAe819\"\n },\n \"rgb\": {\n \"red\": 9145,\n \"green\": 4381,\n \"blue\": 7431\n }\n },\n \"underline\": false,\n \"strike\": false,\n \"italic\": false,\n \"font_name\": {\n \"name\": \"ੵ곊西킜劷ᘱ瀄\",\n \"style\": \"VL8Eu\"\n }\n },\n \"range\": {\n \"start_index\": 1725,\n \"end_index\": 4603\n },\n \"paragraph_style\": {\n \"spacing\": {\n \"before\": 7522,\n \"line\": 90.12815991418677,\n \"after\": 5674\n },\n \"level\": 7170,\n \"halign\": \"CENTER\"\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 \"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": "c22db491-18bf-4db6-97e4-a4048dd5f9a2", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", "style" ], "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 \"object\": {\n \"zone_id\": \"bC755CC4-6EBF-8ADF-37eb-cb96144F9a9c\",\n \"object_id\": \"bEf4E370-Cd85-c5B8-cDcC-339dc9E68b27\",\n \"frame_id\": \"f0a692D9-Cf68-0c8d-0384-eCa41bC70C6c\"\n },\n \"payload\": {\n \"all_text\": true,\n \"portion_style\": {\n \"fontweight\": \"MEDIUM\",\n \"size\": 3638.390129193547,\n \"color\": {\n \"hsb\": {\n \"saturation\": 2508.482434141348,\n \"brightness\": 5560.8753275157105,\n \"hue\": 7915.3544130535565\n },\n \"hex\": {\n \"value\": \"bFbAe819\"\n },\n \"rgb\": {\n \"red\": 9145,\n \"green\": 4381,\n \"blue\": 7431\n }\n },\n \"underline\": false,\n \"strike\": false,\n \"italic\": false,\n \"font_name\": {\n \"name\": \"ੵ곊西킜劷ᘱ瀄\",\n \"style\": \"VL8Eu\"\n }\n },\n \"range\": {\n \"start_index\": 1725,\n \"end_index\": 4603\n },\n \"paragraph_style\": {\n \"spacing\": {\n \"before\": 7522,\n \"line\": 90.12815991418677,\n \"after\": 5674\n },\n \"level\": 7170,\n \"halign\": \"CENTER\"\n }\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": "7a210333-542b-4550-9b04-00f33518b5cd", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", "style" ], "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 \"object\": {\n \"zone_id\": \"bC755CC4-6EBF-8ADF-37eb-cb96144F9a9c\",\n \"object_id\": \"bEf4E370-Cd85-c5B8-cDcC-339dc9E68b27\",\n \"frame_id\": \"f0a692D9-Cf68-0c8d-0384-eCa41bC70C6c\"\n },\n \"payload\": {\n \"all_text\": true,\n \"portion_style\": {\n \"fontweight\": \"MEDIUM\",\n \"size\": 3638.390129193547,\n \"color\": {\n \"hsb\": {\n \"saturation\": 2508.482434141348,\n \"brightness\": 5560.8753275157105,\n \"hue\": 7915.3544130535565\n },\n \"hex\": {\n \"value\": \"bFbAe819\"\n },\n \"rgb\": {\n \"red\": 9145,\n \"green\": 4381,\n \"blue\": 7431\n }\n },\n \"underline\": false,\n \"strike\": false,\n \"italic\": false,\n \"font_name\": {\n \"name\": \"ੵ곊西킜劷ᘱ瀄\",\n \"style\": \"VL8Eu\"\n }\n },\n \"range\": {\n \"start_index\": 1725,\n \"end_index\": 4603\n },\n \"paragraph_style\": {\n \"spacing\": {\n \"before\": 7522,\n \"line\": 90.12815991418677,\n \"after\": 5674\n },\n \"level\": 7170,\n \"halign\": \"CENTER\"\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 \"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": "2c9a33df-8bf2-4063-8573-6deed8052830", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", "style" ], "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 \"object\": {\n \"zone_id\": \"bC755CC4-6EBF-8ADF-37eb-cb96144F9a9c\",\n \"object_id\": \"bEf4E370-Cd85-c5B8-cDcC-339dc9E68b27\",\n \"frame_id\": \"f0a692D9-Cf68-0c8d-0384-eCa41bC70C6c\"\n },\n \"payload\": {\n \"all_text\": true,\n \"portion_style\": {\n \"fontweight\": \"MEDIUM\",\n \"size\": 3638.390129193547,\n \"color\": {\n \"hsb\": {\n \"saturation\": 2508.482434141348,\n \"brightness\": 5560.8753275157105,\n \"hue\": 7915.3544130535565\n },\n \"hex\": {\n \"value\": \"bFbAe819\"\n },\n \"rgb\": {\n \"red\": 9145,\n \"green\": 4381,\n \"blue\": 7431\n }\n },\n \"underline\": false,\n \"strike\": false,\n \"italic\": false,\n \"font_name\": {\n \"name\": \"ੵ곊西킜劷ᘱ瀄\",\n \"style\": \"VL8Eu\"\n }\n },\n \"range\": {\n \"start_index\": 1725,\n \"end_index\": 4603\n },\n \"paragraph_style\": {\n \"spacing\": {\n \"before\": 7522,\n \"line\": 90.12815991418677,\n \"after\": 5674\n },\n \"level\": 7170,\n \"halign\": \"CENTER\"\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": "d98012dd-0194-4d00-91a1-d60c3a13be50", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", "style" ], "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 \"object\": {\n \"zone_id\": \"bC755CC4-6EBF-8ADF-37eb-cb96144F9a9c\",\n \"object_id\": \"bEf4E370-Cd85-c5B8-cDcC-339dc9E68b27\",\n \"frame_id\": \"f0a692D9-Cf68-0c8d-0384-eCa41bC70C6c\"\n },\n \"payload\": {\n \"all_text\": true,\n \"portion_style\": {\n \"fontweight\": \"MEDIUM\",\n \"size\": 3638.390129193547,\n \"color\": {\n \"hsb\": {\n \"saturation\": 2508.482434141348,\n \"brightness\": 5560.8753275157105,\n \"hue\": 7915.3544130535565\n },\n \"hex\": {\n \"value\": \"bFbAe819\"\n },\n \"rgb\": {\n \"red\": 9145,\n \"green\": 4381,\n \"blue\": 7431\n }\n },\n \"underline\": false,\n \"strike\": false,\n \"italic\": false,\n \"font_name\": {\n \"name\": \"ੵ곊西킜劷ᘱ瀄\",\n \"style\": \"VL8Eu\"\n }\n },\n \"range\": {\n \"start_index\": 1725,\n \"end_index\": 4603\n },\n \"paragraph_style\": {\n \"spacing\": {\n \"before\": 7522,\n \"line\": 90.12815991418677,\n \"after\": 5674\n },\n \"level\": 7170,\n \"halign\": \"CENTER\"\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 } } ], "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": "47aeb858-8276-45b9-9ce6-8520b255a49f", "name": "Text", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Read and mutate text on any text-bearing object, including styling." } }