Archive sites
archive_sites
Puts one or more sites in the Archive of their workspace, at most 200 per call.
Archived sites leave the dashboard lists and list_sites, unless list_sites is called with archived as true, but they still count toward the plan and are billed exactly the same. A site in a folder leaves that folder, and unarchive_sites puts it back there when the folder still exists.
Archiving never unpublishes, so a live site stays live. If you also want it offline, the tool tells the client to confirm with you first and then call unpublish_site, which needs publish:write.
Sites from another workspace, sites already archived and deleted sites are skipped rather than failing the call, so read archivedIds in the response to see what was archived. When every site is skipped, the whole call is refused. See Archive projects.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
workspaceId |
string | Yes | The workspace the sites belong to. |
projectIds |
array of strings | Yes | The site ids to archive, from list_sites, at most 200. |