{"id":"dc5d9da1-5d55-4486-8a17-7ecc11355f82","createdDate":"2023-07-30T12:36:58.932Z","updatedDate":"2023-07-30T12:36:58.932Z","resourceId":"ec251149-3946-484b-9b47-3a232ebfc79d","api":{"schema":{"object":{"displayName":"Folder Object","description":"","slug":"folder-object","$ref":"#/components/schemas/com.wixpress.sitefolders.v2.api.Folder","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"methods":[{"summary":"Query Folders","description":"Retrieves a list folders, given the provided paging, sorting and filtering.\n> **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.","operationId":"com.wixpress.sitefolders.v2.api.SiteFoldersServiceV2.QueryFolders","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.sitefolders.v2.api.QueryFoldersResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/site-folders/v2/folders","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/site-folders/v2/folders","destinationPath":"/v2/folders","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryFoldersRequest","description":"","properties":{"query":{"$ref":"#/components/schemas/com.wixpress.sitefolders.v2.api.QueryV2","summary":"query","description":"Filtering, sorting and paging for retrieving the folders.","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.sitefolders.v2.api.SiteFoldersServiceV2","errors":[],"exposure":"PUBLIC","permissions":["FOLDERS.VIEW"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.proto:site-folders-api","serviceArtifactId":"com.wixpress.site-folders-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.sitefolders.v2.api.QueryFoldersRequest","responseMessage":"com.wixpress.sitefolders.v2.api.QueryFoldersResponse"},"legacyExamples":[{"name":"QueryFolders","type":"METHOD","content":{"title":"QueryFolders","request":"curl -X POST 'https://www.wixapis.com/site-folders/v2/folders/query' \\\n -H 'Content-Type: application/json' \\\n -H 'Accept: application/json, text/plain, */*' \\\n -H '' \\\n -H 'wix-account-id: 4eef80de-db78-465c-8f30-96004676c394' \\\n -d '{\"query\":{\"filter\":{\"name\":{\"$contains\":\"Folder\"}}}}'","response":"{\"folders\":[\n {\"id\":\"d4991e1d-1d41-4074-863f-e7fbd21e8526\",\"name\":\"Folder 1\",\"createdDate\":\"2021-05-05T06:24:12.000Z\",\"updatedDate\":\"2021-10-10T14:32:48.000Z\",\"siteCount\":0,\"parentId\":\"\"},\n {\"id\":\"480b60ff-db55-4a22-9f87-31ed790ce509\",\"name\":\"Folder 2\",\"createdDate\":\"2020-11-15T17:56:22.000Z\",\"updatedDate\":\"2021-08-17T15:37:40.000Z\",\"siteCount\":0,\"parentId\":\"\"},\n {\"id\":\"b6b08570-7e79-4768-8817-b237f7b16e22\",\"name\":\"Folder 3\",\"createdDate\":\"2021-10-27T12:25:31.000Z\",\"updatedDate\":\"2021-10-27T12:25:43.000Z\",\"siteCount\":1,\"parentId\":\"480b60ff-db55-4a22-9f87-31ed790ce509\"}\n ],\n \"metadata\": {\n \"count\": 3\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"post","path":"/v2/folders/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.sitefolders.v2.api.SiteFoldersServiceV2","errors":[],"exposure":"PUBLIC","permissions":["FOLDERS.VIEW"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.proto:site-folders-api","serviceArtifactId":"com.wixpress.site-folders-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.sitefolders.v2.api.QueryFoldersRequest","responseMessage":"com.wixpress.sitefolders.v2.api.QueryFoldersResponse"},"legacyExamples":[{"name":"QueryFolders","type":"METHOD","content":{"title":"QueryFolders","request":"curl -X POST 'https://www.wixapis.com/site-folders/v2/folders/query' \\\n -H 'Content-Type: application/json' \\\n -H 'Accept: application/json, text/plain, */*' \\\n -H '' \\\n -H 'wix-account-id: 4eef80de-db78-465c-8f30-96004676c394' \\\n -d '{\"query\":{\"filter\":{\"name\":{\"$contains\":\"Folder\"}}}}'","response":"{\"folders\":[\n {\"id\":\"d4991e1d-1d41-4074-863f-e7fbd21e8526\",\"name\":\"Folder 1\",\"createdDate\":\"2021-05-05T06:24:12.000Z\",\"updatedDate\":\"2021-10-10T14:32:48.000Z\",\"siteCount\":0,\"parentId\":\"\"},\n {\"id\":\"480b60ff-db55-4a22-9f87-31ed790ce509\",\"name\":\"Folder 2\",\"createdDate\":\"2020-11-15T17:56:22.000Z\",\"updatedDate\":\"2021-08-17T15:37:40.000Z\",\"siteCount\":0,\"parentId\":\"\"},\n {\"id\":\"b6b08570-7e79-4768-8817-b237f7b16e22\",\"name\":\"Folder 3\",\"createdDate\":\"2021-10-27T12:25:31.000Z\",\"updatedDate\":\"2021-10-27T12:25:43.000Z\",\"siteCount\":1,\"parentId\":\"480b60ff-db55-4a22-9f87-31ed790ce509\"}\n ],\n \"metadata\": {\n \"count\": 3\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"Query Folders","slugifiedName":"query-folders"}},{"summary":"Create Folder","description":"Creates a folder.\n> **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.","operationId":"com.wixpress.sitefolders.v2.api.SiteFoldersServiceV2.CreateFolder","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.sitefolders.v2.api.CreateFolderResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/site-folders/v2/folders","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/site-folders/v2/folders","destinationPath":"/v2/folders","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateFolderRequest","description":"","properties":{"folder":{"$ref":"#/components/schemas/com.wixpress.sitefolders.v2.api.Folder","summary":"folder","description":"Folder object to create.","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["folder.name"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.sitefolders.v2.api.SiteFoldersServiceV2","errors":[{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"duplicate_folder_name"}],"exposure":"PUBLIC","permissions":["folders.create"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.proto:site-folders-api","serviceArtifactId":"com.wixpress.site-folders-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.sitefolders.v2.api.CreateFolderRequest","responseMessage":"com.wixpress.sitefolders.v2.api.CreateFolderResponse"},"legacyExamples":[{"name":"CreateFolder","type":"METHOD","content":{"title":"CreateFolder","request":"curl -X POST 'https://www.wixapis.com/site-folders/v2/folders' \\\n -H 'Content-Type: application/json' \\\n -H 'Accept: application/json, text/plain, */*' \\\n -H 'Authorization: ' \\\n -H 'wix-account-id: 4339fba7-b533-4d10-a91b-822d825f29a5' \\\n -d '{ \"folder\": {\"name\": \"My Folder\", \"parentId\": \"root\"}}'","response":"{\"folder\":{\"id\":\"283f4660-8f6f-462b-94a1-160a57338032\",\"name\":\"My Folder\",\"createdDate\":\"2021-12-13T11:33:56.973Z\",\"updatedDate\":\"2021-12-13T11:33:56.973Z\",\"siteCount\":0,\"parentId\":\"\"}}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"post","path":"/v2/folders","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.sitefolders.v2.api.SiteFoldersServiceV2","errors":[{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"duplicate_folder_name"}],"exposure":"PUBLIC","permissions":["folders.create"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.proto:site-folders-api","serviceArtifactId":"com.wixpress.site-folders-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.sitefolders.v2.api.CreateFolderRequest","responseMessage":"com.wixpress.sitefolders.v2.api.CreateFolderResponse"},"legacyExamples":[{"name":"CreateFolder","type":"METHOD","content":{"title":"CreateFolder","request":"curl -X POST 'https://www.wixapis.com/site-folders/v2/folders' \\\n -H 'Content-Type: application/json' \\\n -H 'Accept: application/json, text/plain, */*' \\\n -H 'Authorization: ' \\\n -H 'wix-account-id: 4339fba7-b533-4d10-a91b-822d825f29a5' \\\n -d '{ \"folder\": {\"name\": \"My Folder\", \"parentId\": \"root\"}}'","response":"{\"folder\":{\"id\":\"283f4660-8f6f-462b-94a1-160a57338032\",\"name\":\"My Folder\",\"createdDate\":\"2021-12-13T11:33:56.973Z\",\"updatedDate\":\"2021-12-13T11:33:56.973Z\",\"siteCount\":0,\"parentId\":\"\"}}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"Create Folder","slugifiedName":"create-folder"}},{"summary":"Update Folder","description":"Updates a folder.\n> **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.","operationId":"com.wixpress.sitefolders.v2.api.SiteFoldersServiceV2.UpdateFolder","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"folder.id","description":"Folder ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.sitefolders.v2.api.UpdateFolderResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/site-folders/v2/folders","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/site-folders/v2/folders","destinationPath":"/v2/folders","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateFolderRequest","description":"","properties":{"folder":{"$ref":"#/components/schemas/com.wixpress.sitefolders.v2.api.Folder","summary":"folder","description":"Folder data.","x-wix-docs":{"exposure":"PUBLIC"}},"fieldMask":{"title":"fieldMask","description":"Set of fields to update.\nExample: `\"fieldMask\": \"name\"`.","$ref":"#/components/schemas/google.protobuf.FieldMask","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["folder.id"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.sitefolders.v2.api.SiteFoldersServiceV2","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"invalid_update_field"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"duplicate_folder_name"}],"exposure":"PUBLIC","permissions":["FOLDERS.UPDATE"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.proto:site-folders-api","serviceArtifactId":"com.wixpress.site-folders-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.sitefolders.v2.api.UpdateFolderRequest","responseMessage":"com.wixpress.sitefolders.v2.api.UpdateFolderResponse"},"legacyExamples":[{"name":"UpdateFolder","type":"METHOD","content":{"title":"UpdateFolder","request":"curl -X PATCH 'https://www.wixapis.com/site-folders/v2/folders/59c80b6f-9cae-49c5-ab0e-83b9a479c573' \\\n -H 'Content-Type: application/json' \\\n -H 'Accept: application/json, text/plain, */*' \\\n -H 'Authorization: ' \\\n -H 'wix-account-id: '\n -d '{\"folder\":{\"id\":\"59c80b6f-9cae-49c5-ab0e-83b9a479c573\",\"name\":\"My Folder 2\"}, \"fieldMask\": \"name\"}'","response":"{\"folder\":{\"id\":\"59c80b6f-9cae-49c5-ab0e-83b9a479c573\",\"name\":\"My Folder 2\",\"siteCount\":0,\"parentId\":\"\"}}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"patch","path":"/v2/folders/{folder.id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.sitefolders.v2.api.SiteFoldersServiceV2","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"invalid_update_field"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"duplicate_folder_name"}],"exposure":"PUBLIC","permissions":["FOLDERS.UPDATE"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.proto:site-folders-api","serviceArtifactId":"com.wixpress.site-folders-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.sitefolders.v2.api.UpdateFolderRequest","responseMessage":"com.wixpress.sitefolders.v2.api.UpdateFolderResponse"},"legacyExamples":[{"name":"UpdateFolder","type":"METHOD","content":{"title":"UpdateFolder","request":"curl -X PATCH 'https://www.wixapis.com/site-folders/v2/folders/59c80b6f-9cae-49c5-ab0e-83b9a479c573' \\\n -H 'Content-Type: application/json' \\\n -H 'Accept: application/json, text/plain, */*' \\\n -H 'Authorization: ' \\\n -H 'wix-account-id: '\n -d '{\"folder\":{\"id\":\"59c80b6f-9cae-49c5-ab0e-83b9a479c573\",\"name\":\"My Folder 2\"}, \"fieldMask\": \"name\"}'","response":"{\"folder\":{\"id\":\"59c80b6f-9cae-49c5-ab0e-83b9a479c573\",\"name\":\"My Folder 2\",\"siteCount\":0,\"parentId\":\"\"}}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"Update Folder","slugifiedName":"update-folder"}},{"summary":"Move Folders","description":"Move folders to a specific folder or to root level.\n> **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.","operationId":"com.wixpress.sitefolders.v2.api.SiteFoldersServiceV2.MoveFolders","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.sitefolders.v2.api.MoveFoldersResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/site-folders/v2/folders","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/site-folders/v2/folders","destinationPath":"/v2/folders","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"MoveFoldersRequest","description":"","properties":{"folderIds":{"title":"folderIds","description":"List of folders IDs. Limited to 1000 folders.","maxLength":36,"minItems":1,"maxItems":1000,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"targetFolderId":{"title":"targetFolderId","description":"New parent ID.\nEmpty if folder is moved to root level.","maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["folderIds"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.sitefolders.v2.api.SiteFoldersServiceV2","errors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"folder_not_found"}],"exposure":"PUBLIC","permissions":["FOLDERS.MOVE, FOLDERS.VIEW"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.proto:site-folders-api","serviceArtifactId":"com.wixpress.site-folders-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.sitefolders.v2.api.MoveFoldersRequest","responseMessage":"com.wixpress.sitefolders.v2.api.MoveFoldersResponse"},"legacyExamples":[{"name":"MoveFolders","type":"METHOD","content":{"title":"MoveFolders","request":"curl -X PATCH 'https://www.wixapis.com/site-folders/v2/folders/bulk/move' \\\n -H 'Content-Type: application/json' \\\n -H 'Accept: application/json, text/plain, */*' \\\n -H 'Authorization: ' \\\n -H 'wix-account-id: f8d73a16-dbb2-428e-899e-092ceb49aa3f'\n -d '{\"folderIds\": [\"f8dc078c-7642-4b2a-b662-d6569507bf57\", \"f8207974-6b78-428b-938f-f5d7ca98580d\"], \"targetFolderId\": \"836bc7cf-0477-432b-b792-3d36411c07bc\"}'","response":"{\"folders\": [\n {\n \"id\": \"f8dc078c-7642-4b2a-b662-d6569507bf57\",\n \"name\": \"My Folder 1\",\n \"createdDate\": null,\n \"updatedDate\": null,\n \"siteCount\": 0,\n \"parentId\": \"836bc7cf-0477-432b-b792-3d36411c07bc\"\n },\n {\n \"id\": \"f8207974-6b78-428b-938f-f5d7ca98580d\",\n \"name\": \"My Folder 2\",\n \"createdDate\": null,\n \"updatedDate\": null,\n \"siteCount\": 0,\n \"parentId\": \"836bc7cf-0477-432b-b792-3d36411c07bc\"\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"patch","path":"/v2/folders/bulk/move","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.sitefolders.v2.api.SiteFoldersServiceV2","errors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"folder_not_found"}],"exposure":"PUBLIC","permissions":["FOLDERS.MOVE, FOLDERS.VIEW"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.proto:site-folders-api","serviceArtifactId":"com.wixpress.site-folders-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.sitefolders.v2.api.MoveFoldersRequest","responseMessage":"com.wixpress.sitefolders.v2.api.MoveFoldersResponse"},"legacyExamples":[{"name":"MoveFolders","type":"METHOD","content":{"title":"MoveFolders","request":"curl -X PATCH 'https://www.wixapis.com/site-folders/v2/folders/bulk/move' \\\n -H 'Content-Type: application/json' \\\n -H 'Accept: application/json, text/plain, */*' \\\n -H 'Authorization: ' \\\n -H 'wix-account-id: f8d73a16-dbb2-428e-899e-092ceb49aa3f'\n -d '{\"folderIds\": [\"f8dc078c-7642-4b2a-b662-d6569507bf57\", \"f8207974-6b78-428b-938f-f5d7ca98580d\"], \"targetFolderId\": \"836bc7cf-0477-432b-b792-3d36411c07bc\"}'","response":"{\"folders\": [\n {\n \"id\": \"f8dc078c-7642-4b2a-b662-d6569507bf57\",\n \"name\": \"My Folder 1\",\n \"createdDate\": null,\n \"updatedDate\": null,\n \"siteCount\": 0,\n \"parentId\": \"836bc7cf-0477-432b-b792-3d36411c07bc\"\n },\n {\n \"id\": \"f8207974-6b78-428b-938f-f5d7ca98580d\",\n \"name\": \"My Folder 2\",\n \"createdDate\": null,\n \"updatedDate\": null,\n \"siteCount\": 0,\n \"parentId\": \"836bc7cf-0477-432b-b792-3d36411c07bc\"\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"Move Folders","slugifiedName":"move-folders"}},{"summary":"Delete Folder","description":"Deletes a folder and moves its content to the parent folder (or to root level if no parent folder exists).\n> **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.","operationId":"com.wixpress.sitefolders.v2.api.SiteFoldersServiceV2.DeleteFolder","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Folder ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/google.protobuf.Empty","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/site-folders/v2/folders","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/site-folders/v2/folders","destinationPath":"/v2/folders","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.sitefolders.v2.api.SiteFoldersServiceV2","errors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"folder_not_found"}],"exposure":"PUBLIC","permissions":["folders.delete, FOLDERS.MOVE"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.proto:site-folders-api","serviceArtifactId":"com.wixpress.site-folders-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.sitefolders.v2.api.DeleteFolderRequest","responseMessage":"google.protobuf.Empty"},"legacyExamples":[{"name":"DeleteFolder","type":"METHOD","content":{"title":"DeleteFolder","request":"curl -X DELETE 'https://www.wixapis.com/site-folders/v2/folders/6af5d704-e949-4ca0-a646-08f5c25bfb64' \\\n -H 'Content-Type: application/json' \\\n -H 'Accept: application/json, text/plain, */*' \\\n -H 'Authorization: ' \\\n -H 'wix-account-id: c07eba20-d970-49af-8a6b-c60e0741d876'"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"delete","path":"/v2/folders/{id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.sitefolders.v2.api.SiteFoldersServiceV2","errors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"folder_not_found"}],"exposure":"PUBLIC","permissions":["folders.delete, FOLDERS.MOVE"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.proto:site-folders-api","serviceArtifactId":"com.wixpress.site-folders-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.sitefolders.v2.api.DeleteFolderRequest","responseMessage":"google.protobuf.Empty"},"legacyExamples":[{"name":"DeleteFolder","type":"METHOD","content":{"title":"DeleteFolder","request":"curl -X DELETE 'https://www.wixapis.com/site-folders/v2/folders/6af5d704-e949-4ca0-a646-08f5c25bfb64' \\\n -H 'Content-Type: application/json' \\\n -H 'Accept: application/json, text/plain, */*' \\\n -H 'Authorization: ' \\\n -H 'wix-account-id: c07eba20-d970-49af-8a6b-c60e0741d876'"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"Delete Folder","slugifiedName":"delete-folder"}},{"summary":"Move Sites To Folder","description":"Moves sites into a specific folder/root.\nLimited to 500 sites per request.\n> **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.","operationId":"com.wixpress.sitefolders.v2.api.SiteFoldersServiceV2.MoveSitesToFolder","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/google.protobuf.Empty","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/site-folders/v2/folders","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/site-folders/v2/folders","destinationPath":"/v2/folders","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"MoveSitesToFolderRequest","description":"","properties":{"targetFolderId":{"title":"targetFolderId","description":"Folder ID.\nEmpty when moving sites to root level.","maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"sites":{"title":"sites","description":"Sites to move.\nCurrently supports only site IDs and is limited to 500 sites.\nFor example: `{ \"id\": { \"$in\": [\"\", \"\", ...] } }`.","type":"object","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["sites"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.sitefolders.v2.api.SiteFoldersServiceV2","errors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"folder_not_found"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"metasite_ids_count_exceeded"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"invalid_move_spec"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"malformed_filter"}],"exposure":"PUBLIC","permissions":["site-actions.move-site-to-folder"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.proto:site-folders-api","serviceArtifactId":"com.wixpress.site-folders-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.sitefolders.v2.api.MoveSitesToFolderRequest","responseMessage":"google.protobuf.Empty"},"legacyExamples":[{"name":"MoveSitesToFolder","type":"METHOD","content":{"title":"MoveSitesToFolder","request":"curl -X POST 'https://www.wixapis.com/site-folders/v2/folders/bulk/sites/move' \\\n -H 'Content-Type: application/json' \\\n -H 'Accept: application/json, text/plain, */*' \\\n -H 'Authorization: ' \\\n -H 'wix-account-id: 4eef80de-db78-465c-8f30-96004676c394' \\\n -d '{\n \"targetFolderId\": \"5a8a82cc-0246-4ed9-ba15-cd4653e8267a\",\n \"sites\":{\"id\":{\"$in\":[\"f8bdbb86-a472-4de2-8300-0d5386525639\"]}}}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"post","path":"/v2/folders/bulk/sites/move","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.sitefolders.v2.api.SiteFoldersServiceV2","errors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"folder_not_found"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"metasite_ids_count_exceeded"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"invalid_move_spec"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"malformed_filter"}],"exposure":"PUBLIC","permissions":["site-actions.move-site-to-folder"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.proto:site-folders-api","serviceArtifactId":"com.wixpress.site-folders-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.sitefolders.v2.api.MoveSitesToFolderRequest","responseMessage":"google.protobuf.Empty"},"legacyExamples":[{"name":"MoveSitesToFolder","type":"METHOD","content":{"title":"MoveSitesToFolder","request":"curl -X POST 'https://www.wixapis.com/site-folders/v2/folders/bulk/sites/move' \\\n -H 'Content-Type: application/json' \\\n -H 'Accept: application/json, text/plain, */*' \\\n -H 'Authorization: ' \\\n -H 'wix-account-id: 4eef80de-db78-465c-8f30-96004676c394' \\\n -d '{\n \"targetFolderId\": \"5a8a82cc-0246-4ed9-ba15-cd4653e8267a\",\n \"sites\":{\"id\":{\"$in\":[\"f8bdbb86-a472-4de2-8300-0d5386525639\"]}}}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"Move Sites To Folder","slugifiedName":"move-sites-to-folder"}},{"summary":"Get Folder By Site","description":"Returns data about the folder that contains the specified site.\n> **Note**: If the specified site is root level, the returned folder object will be empty.\n> **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.","operationId":"com.wixpress.sitefolders.v2.api.SiteFoldersServiceV2.GetFolderBySite","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"siteId","description":"Site ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.sitefolders.v2.api.GetFolderBySiteResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/site-folders/v2/folders","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/site-folders/v2/folders","destinationPath":"/v2/folders","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.sitefolders.v2.api.SiteFoldersServiceV2","errors":[],"exposure":"PUBLIC","permissions":["FOLDERS.VIEW"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.proto:site-folders-api","serviceArtifactId":"com.wixpress.site-folders-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.sitefolders.v2.api.GetFolderBySiteRequest","responseMessage":"com.wixpress.sitefolders.v2.api.GetFolderBySiteResponse"},"legacyExamples":[{"name":"GetFolderBySite","type":"METHOD","content":{"title":"GetFolderBySite","request":"curl 'https://www.wixapis.com/site-folders/v2/folders/sites/a1c0588c-82dd-4f33-b0a4-a94ff2f9117a' \\\n -H 'Content-Type: application/json' \\\n -H 'Accept: application/json, text/plain, */*' \\\n -H 'Authorization: ' \\\n -H 'wix-account-id: 151fa8fd-7011-4361-8e88-3f0a3adde032'","response":"{\n \"folder\": {\n \"id\": \"10c18ce0-fb50-4bc1-982e-e6d6e5317c2d\",\n \"name\": \"My First Folder\",\n \"createdDate\": \"2021-04-20T10:14:14.000Z\",\n \"updatedDate\": \"2021-07-13T09:03:09.000Z\",\n \"siteCount\": 1,\n \"parentId\": \"dc11042c-19d0-4638-b3b5-0a3c85b402a6\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"get","path":"/v2/folders/sites/{siteId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.sitefolders.v2.api.SiteFoldersServiceV2","errors":[],"exposure":"PUBLIC","permissions":["FOLDERS.VIEW"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.proto:site-folders-api","serviceArtifactId":"com.wixpress.site-folders-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.sitefolders.v2.api.GetFolderBySiteRequest","responseMessage":"com.wixpress.sitefolders.v2.api.GetFolderBySiteResponse"},"legacyExamples":[{"name":"GetFolderBySite","type":"METHOD","content":{"title":"GetFolderBySite","request":"curl 'https://www.wixapis.com/site-folders/v2/folders/sites/a1c0588c-82dd-4f33-b0a4-a94ff2f9117a' \\\n -H 'Content-Type: application/json' \\\n -H 'Accept: application/json, text/plain, */*' \\\n -H 'Authorization: ' \\\n -H 'wix-account-id: 151fa8fd-7011-4361-8e88-3f0a3adde032'","response":"{\n \"folder\": {\n \"id\": \"10c18ce0-fb50-4bc1-982e-e6d6e5317c2d\",\n \"name\": \"My First Folder\",\n \"createdDate\": \"2021-04-20T10:14:14.000Z\",\n \"updatedDate\": \"2021-07-13T09:03:09.000Z\",\n \"siteCount\": 1,\n \"parentId\": \"dc11042c-19d0-4638-b3b5-0a3c85b402a6\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"Get Folder By Site","slugifiedName":"get-folder-by-site"}}],"webhooks":[],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Site Folders API\n\nThe Site Folders API enables the management of sites in an account by organizing them into folders. \n\n![Site Folders](../docs/SiteFolders.jpg)\n\n\nWith the Folders APIs you can create folders, update folder names, and delete folders. \nYou can also get a parent folder’s ID by site ID, and you can move folders and sites between folders.\n\n> **Important**: This API is accessible via API keys, which are currently available to selected beta users only. You will not be able to access this API with a standard Auth header. \n\nSite owners and contributors can also manage their sites and folders via the [My Sites](https://manage.wix.com/account/sites) page.\n\n\n## Terminology\n* **Account**: A Wix account includes all the assets that site owners/contributors interact with: sites, folders, premium plans, domains, and more. An account can have one or more users. Standard accounts have one user while team accounts can have multiple users.\n* **Site**: A website in the account. Sites are accessible to site owners and contributors according to the specific permissions they hold on a specific site or on the entire account.\n* **Folder**: A group of sites that account users can create to organize their sites. Each site can only belong to one folder.\n\n\n## Sample User Flow\n\nAn agency that builds Wix sites for customers might set up their folders according to their internal workflow processes, and only share the site with the customer once it has reached a certain stage in the process. In such a situation the flow might look like this:\n\n1. Call the [Create Folder](https://dev.wix.com/api/rest/drafts/site-folders/create-folder) endpoint as often as required to create folders with all your workflow process names, including “Design”, “QA”, “Suspended”, and “Live”. \n2. As the site moves along the workflow process, call the [Move Sites to Folder](https://dev.wix.com/api/rest/drafts/site-folders/move-sites-to-folder) endpoint to move the sites to the relevant folder, for example sites that have completed design and are waiting for QA into the designated \"QA\" folder. \n3. Periodically get all unpaid site IDs from an external list. \n4. Call the [Move Sites to Folder](https://dev.wix.com/api/rest/drafts/site-folders/move-sites-to-folder) endpoint to move all unpaid sites into the designated \"Suspended\" folder. \n5. If your process changes, call the [Update Folder](https://dev.wix.com/api/rest/drafts/site-folders/move-sites-to-folder) endpoint to rename a folder.\n\n\n## Limitations\n* Each site can only belong to one folder.\n* Each account can have a maximum of 500 folders in the Wix account (not currently enforced via API).\n* Up to 1,000 folders can be moved by `MoveFolders`.\n* Up to 500 sites can be moved by `MoveSitesToFolder`.\n* Up to 1,000 folders can be retrieved by `QueryFolders`.\n","sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","path":"docs/README-External.md"}],"components":{"schemas":{"com.wixpress.sitefolders.v2.api.Folder":{"type":"object","properties":{"id":{"title":"id","description":"Folder ID.","format":"GUID","readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"name":{"title":"name","description":"Folder name.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"createdDate":{"title":"createdDate","description":"Date the folder was created.","readOnly":true,"type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"updatedDate":{"title":"updatedDate","description":"Date the folder was last updated.","readOnly":true,"type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"siteCount":{"title":"siteCount","description":"Number of sites in the folder.","readOnly":true,"type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"parentId":{"title":"parentId","description":"Parent folder ID. When empty, the site is at root level.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"path":{"title":"path","description":"Path including all parent folders from root to the current folder, in order. When empty, the site or folder is at root level.","readOnly":true,"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/com.wixpress.sitefolders.v2.api.FolderBasicInfo"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Folder","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"title":"seconds","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"nanos":{"title":"nanos","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Timestamp","description":""},"com.wixpress.sitefolders.v2.api.FolderBasicInfo":{"type":"object","properties":{"id":{"title":"id","description":"Folder ID.","format":"GUID","readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"name":{"title":"name","description":"Folder name.","readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FolderBasicInfo","description":""},"com.wixpress.sitefolders.v2.api.QueryFoldersRequest":{"type":"object","properties":{"query":{"$ref":"#/components/schemas/com.wixpress.sitefolders.v2.api.QueryV2","summary":"query","description":"Filtering, sorting and paging for retrieving the folders.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryFoldersRequest","description":""},"com.wixpress.sitefolders.v2.api.QueryV2":{"type":"object","properties":{"filter":{"title":"filter","description":"Filter folders by name/id/parentId in the following format:\n`\"filter\" : {\n\"name\": \"my-folder\",\n\"id\":{\"$in\":[\"value1\", \"value2\"]},\n\"parentId\": \"value\",\n}`.\nExamples:\n- `{\"filter\": {\"name\": \"my folder\"}}`\n- `{\"filter\": {\"name\": {\"$startsWith\" :\"my folder\"}}}`\n- `{\"filter\": {\"name\": {\"$contains\" :\"my folder\"}}}`\n- `{\"filter\": {\"id\": \"d20c988a-5f6f-4b55-aeb1-0dfb7646da38\"}}`\n- `{\"filter\": {\"id\":{\"$in\":[\"6a26dd24-af0b-474a-813a-c442093483a9\", \"d5f5f00d-b600-4114-8ff0-e86005c050ce\"]}}}`\n- `{\"filter\": {\"parentId\":{\"283f4660-8f6f-462b-94a1-160a57338032\"}}}`\n- `{\"filter\": {\"parentId\": { \"$exists\": false }}}` - query root's folders","type":"object","x-wix-docs":{"exposure":"PUBLIC"}},"sort":{"title":"sort","description":"Sort object in the following format:\n`[{\"fieldName\":\"name\",\"order\":\"ASC\"}]`.\nExamples:\n- `{\"sort\": [{\"fieldName\":\"name\",\"order\":\"ASC\"}]}`","minItems":0,"maxItems":4,"type":"array","items":{"$ref":"#/components/schemas/wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryV2","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wixpress.sitefolders.v2.api.QueryV2.pagingMethod"}]},"com.wixpress.sitefolders.v2.api.QueryV2.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"paging":{"$ref":"#/components/schemas/wix.common.Paging","summary":"paging","description":"Paging options to limit and skip the number of items (default limit is 1000).","x-wix-docs":{"exposure":"PUBLIC"}}}},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"title":"fields","description":"","type":"object","format":"map","properties":{"key:value":{"type":"object","description":"\"key\" of type string, \"value\" of type object","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"title":"nullValue","description":"","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC"}},"numberValue":{"title":"numberValue","description":"","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"stringValue":{"title":"stringValue","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"boolValue":{"title":"boolValue","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"structValue":{"title":"structValue","description":"","type":"object","x-wix-docs":{"exposure":"PUBLIC"}},"listValue":{"title":"listValue","description":"","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"title":"values","description":"","$ref":"#/components/schemas/google.protobuf.Value","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListValue","description":""},"wix.common.Sorting":{"type":"object","properties":{"fieldName":{"title":"fieldName","description":"Name of the field to sort by.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"order":{"title":"order","description":"Sort order.","type":"string","$ref":"#/components/schemas/wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Sorting","description":""},"wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"wix.common.Paging":{"type":"object","properties":{"limit":{"title":"limit","description":"Number of items to load.","minimum":0,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"offset":{"title":"offset","description":"Number of items to skip in the current sort order.","minimum":0,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Paging","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"title":"value","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Int32Value","description":""},"com.wixpress.sitefolders.v2.api.QueryFoldersResponse":{"type":"object","properties":{"folders":{"title":"folders","description":"List of retrieved folders.\nMaximal number of retrieved folders is 1000.","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.sitefolders.v2.api.Folder"},"x-wix-docs":{"exposure":"PUBLIC"}},"metadata":{"$ref":"#/components/schemas/com.wixpress.sitefolders.v2.api.PagingMetadataV2","summary":"metadata","description":"Meta data about the returned folders","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryFoldersResponse","description":""},"com.wixpress.sitefolders.v2.api.PagingMetadataV2":{"type":"object","properties":{"count":{"title":"count","description":"Number of items returned in the response.","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"offset":{"title":"offset","description":"Offset that was requested.","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"total":{"title":"total","description":"Total number of items that match the query.","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"tooManyToCount":{"title":"tooManyToCount","description":"Flag that indicates the server failed to calculate the `total` field.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PagingMetadataV2","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BoolValue","description":""},"com.wixpress.sitefolders.v2.api.CreateFolderRequest":{"type":"object","properties":{"folder":{"$ref":"#/components/schemas/com.wixpress.sitefolders.v2.api.Folder","summary":"folder","description":"Folder object to create.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateFolderRequest","description":""},"com.wixpress.sitefolders.v2.api.CreateFolderResponse":{"type":"object","properties":{"folder":{"$ref":"#/components/schemas/com.wixpress.sitefolders.v2.api.Folder","summary":"folder","description":"Folder data.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateFolderResponse","description":""},"com.wixpress.sitefolders.v2.api.UpdateFolderRequest":{"type":"object","properties":{"folder":{"$ref":"#/components/schemas/com.wixpress.sitefolders.v2.api.Folder","summary":"folder","description":"Folder data.","x-wix-docs":{"exposure":"PUBLIC"}},"fieldMask":{"title":"fieldMask","description":"Set of fields to update.\nExample: `\"fieldMask\": \"name\"`.","$ref":"#/components/schemas/google.protobuf.FieldMask","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdateFolderRequest","description":""},"google.protobuf.FieldMask":{"type":"object","properties":{"paths":{"title":"paths","description":"","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FieldMask","description":""},"com.wixpress.sitefolders.v2.api.UpdateFolderResponse":{"type":"object","properties":{"folder":{"$ref":"#/components/schemas/com.wixpress.sitefolders.v2.api.Folder","summary":"folder","description":"Folder data.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdateFolderResponse","description":""},"com.wixpress.sitefolders.v2.api.MoveFoldersRequest":{"type":"object","properties":{"folderIds":{"title":"folderIds","description":"List of folders IDs. Limited to 1000 folders.","maxLength":36,"minItems":1,"maxItems":1000,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"targetFolderId":{"title":"targetFolderId","description":"New parent ID.\nEmpty if folder is moved to root level.","maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"MoveFoldersRequest","description":""},"com.wixpress.sitefolders.v2.api.MoveFoldersResponse":{"type":"object","properties":{"folders":{"title":"folders","description":"List of all the account's folders that were successfully moved.","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.sitefolders.v2.api.Folder"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"MoveFoldersResponse","description":""},"com.wixpress.sitefolders.v2.api.DeleteFolderRequest":{"type":"object","properties":{"id":{"title":"id","description":"Folder ID.","maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DeleteFolderRequest","description":""},"google.protobuf.Empty":{"type":"object","properties":{},"title":"Empty","description":""},"com.wixpress.sitefolders.event.api.SiteLabelsChanged":{"type":"object","properties":{"msid":{"title":"msid","description":"metasite id (in lowercase)","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"addedLabels":{"title":"addedLabels","description":"New labels to add to the site","minItems":1,"maxItems":500,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"removedLabels":{"title":"removedLabels","description":"Labels to remove from the site","minItems":1,"maxItems":500,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"context":{"title":"context","description":"the context in which the event was dispatched. is returned with the callback message. optional","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SiteLabelsChanged","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"StringValue","description":""},"com.wixpress.sitefolders.v2.api.MoveSitesToFolderRequest":{"type":"object","properties":{"targetFolderId":{"title":"targetFolderId","description":"Folder ID.\nEmpty when moving sites to root level.","maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"sites":{"title":"sites","description":"Sites to move.\nCurrently supports only site IDs and is limited to 500 sites.\nFor example: `{ \"id\": { \"$in\": [\"\", \"\", ...] } }`.","type":"object","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"MoveSitesToFolderRequest","description":""},"com.wixpress.sitefolders.event.api.MoveSiteToFolderEvent":{"type":"object","properties":{"targetFolderId":{"title":"targetFolderId","description":"Folder ID.\nEmpty when moving sites to root level.","maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"metaSiteIds":{"title":"metaSiteIds","description":"Sites to move.\nCurrently supports only site IDs and is limited to 500 sites.","minItems":1,"maxItems":500,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"MoveSiteToFolderEvent","description":""},"com.wixpress.sitefolders.v2.api.GetFolderBySiteRequest":{"type":"object","properties":{"siteId":{"title":"siteId","description":"Site ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetFolderBySiteRequest","description":""},"com.wixpress.sitefolders.v2.api.GetFolderBySiteResponse":{"type":"object","properties":{"folder":{"$ref":"#/components/schemas/com.wixpress.sitefolders.v2.api.Folder","summary":"folder","description":"Folder containing the specified site. Empty if site is at root level.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetFolderBySiteResponse","description":""}}},"title":"Folder","description":"","fqdn":"wix.site_folders.v2.folder"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Site Folders API\n\nThe Site Folders API enables the management of sites in an account by organizing them into folders. \n\n![Site Folders](../docs/SiteFolders.jpg)\n\n\nWith the Folders APIs you can create folders, update folder names, and delete folders. \nYou can also get a parent folder’s ID by site ID, and you can move folders and sites between folders.\n\n> **Important**: This API is accessible via API keys, which are currently available to selected beta users only. You will not be able to access this API with a standard Auth header. \n\nSite owners and contributors can also manage their sites and folders via the [My Sites](https://manage.wix.com/account/sites) page.\n\n\n## Terminology\n* **Account**: A Wix account includes all the assets that site owners/contributors interact with: sites, folders, premium plans, domains, and more. An account can have one or more users. Standard accounts have one user while team accounts can have multiple users.\n* **Site**: A website in the account. Sites are accessible to site owners and contributors according to the specific permissions they hold on a specific site or on the entire account.\n* **Folder**: A group of sites that account users can create to organize their sites. Each site can only belong to one folder.\n\n\n## Sample User Flow\n\nAn agency that builds Wix sites for customers might set up their folders according to their internal workflow processes, and only share the site with the customer once it has reached a certain stage in the process. In such a situation the flow might look like this:\n\n1. Call the [Create Folder](https://dev.wix.com/api/rest/drafts/site-folders/create-folder) endpoint as often as required to create folders with all your workflow process names, including “Design”, “QA”, “Suspended”, and “Live”. \n2. As the site moves along the workflow process, call the [Move Sites to Folder](https://dev.wix.com/api/rest/drafts/site-folders/move-sites-to-folder) endpoint to move the sites to the relevant folder, for example sites that have completed design and are waiting for QA into the designated \"QA\" folder. \n3. Periodically get all unpaid site IDs from an external list. \n4. Call the [Move Sites to Folder](https://dev.wix.com/api/rest/drafts/site-folders/move-sites-to-folder) endpoint to move all unpaid sites into the designated \"Suspended\" folder. \n5. If your process changes, call the [Update Folder](https://dev.wix.com/api/rest/drafts/site-folders/move-sites-to-folder) endpoint to rename a folder.\n\n\n## Limitations\n* Each site can only belong to one folder.\n* Each account can have a maximum of 500 folders in the Wix account (not currently enforced via API).\n* Up to 1,000 folders can be moved by `MoveFolders`.\n* Up to 500 sites can be moved by `MoveSitesToFolder`.\n* Up to 1,000 folders can be retrieved by `QueryFolders`.\n"}]},"reviewStatus":"APPROVED","isLocked":true}