POST

Bulk Delete Site

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

This endpoint enables you to delete multiple sites.

This is not a permanent delete. Sites are moved to the trash bin and can be restored through site collaborators.

Learn more about deleting multiple sites.

Important: This call requires an account level API key and cannot be authenticated with the standard authorization header.

Endpoint
POST
https://www.wixapis.com/site-actions/v1/bulk/sites/delete
Body Params
idsArray <string>Requiredformat GUIDminItems 1maxItems 20

Site IDs.

Min: 1 site ID
Max: 20 site IDs

Response Object
resultsArray <BulkSiteResult>

List of deletion results.

bulkActionMetadataBulkActionMetadata

Summary of deletion data.

Bulk delete 2 sites
Request
cURL
curl 'https://www.wixapis.com/site-actions/v1/bulk/sites/delete' \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'authorization: <AUTH>' \
  -d '{
    "ids": [
      "9f023696-c821-4e09-b1d0-55357272ff2a",
      "da0c7663-e375-48a9-b273-f0bd45c933a9"
    ]
  }'
Response
JSON
{
  "results": [
    {
      "itemMetadata": {
        "id": "9f023696-c821-4e09-b1d0-55357272ff2a",
        "originalIndex": "0",
        "success": true,
        "error": null
      }
    },
    {
      "itemMetadata": {
        "id": "da0c7663-e375-48a9-b273-f0bd45c933a9",
        "originalIndex": "1",
        "success": false,
        "error": {
          "code": "PREMIUM_NOT_PERMITTED",
          "description": "unassign premium request: NOT_PERMITTED"
        }
      }
    }
  ],
  "bulkActionMetadata": {
    "totalSuccesses": 1,
    "totalFailures": 1
  }
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?