---
title: "Unpublish Agent Pages"
method: POST
path: "/{brand_id}/sites/{site_id}/agent-pages/unpublish"
tags: ["agent-pages"]
---

# Unpublish Agent Pages

`POST /{brand_id}/sites/{site_id}/agent-pages/unpublish`

## Request

- Base URL: `https://api.scrunchai.com/v1`
- URL: `https://api.scrunchai.com/v1/{brand_id}/sites/{site_id}/agent-pages/unpublish`
- Auth: HTTP bearer

Stop serving Agent Pages now. Each path is added to the site's Ignore List, so it stays unpublished through later crawls, and its edge copy is removed within minutes, or before the response with `immediate: true`. Returns one outcome per requested path. Each path can be unpublished once every 5 minutes, and each brand up to 100 paths per rolling hour and 1,000 per rolling 24 hours. Returns 429 with a `Retry-After` header when the brand's quota is used up, and 409 when Agent Pages are not active on the site.

## Path parameters

- `brand_id` integer, required
- `site_id` union, required
  - string
  - string, binary

## Request body

- AgentPagesUnpublishRequest
  - `paths` string[], required: Site-relative paths to unpublish, e.g. ['/pricing'].
  - `immediate` boolean: Delete the edge copies before responding, instead of within minutes. A CDN cache in front of the site can still serve a copy until it expires.

## Response `200`

Successful Response

- AgentPagesUnpublishResponse
  - `results` AgentPagesUnpublishResult[], required
    - `path` string, required
    - `outcome` 'unpublished' | 'already_unpublished' | 'not_found' | 'conflict' | 'cooldown' | 'rate_limited', required
    - `retry_after` string, date-time, nullable
    - `edge` 'deleted' | 'failed' | 'deferred', nullable
  - `quota` AgentPagesRefreshQuotas, required: The brand's rolling windows. A path is queued only while both have room.
    - `hourly` AgentPagesRefreshQuota, required
      - `limit` integer, required
      - `remaining` integer, required
      - `resets_at` string, date-time, nullable
    - `daily` AgentPagesRefreshQuota, required
      - `limit` integer, required
      - `remaining` integer, required
      - `resets_at` string, date-time, nullable

## Other responses

- `422`: Validation Error

## Changes

- **2026-10-29** `fa6217fdd4e1`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/scrunchai/apis/scrunch-data-api/changes/:brand_id/sites/:site_id/agent-pages/unpublish/post.md)

---

[API](https://skmtc.dev/scrunchai/apis/scrunch-data-api.md) - [All operations](https://skmtc.dev/scrunchai/apis/scrunch-data-api/llms.txt) - [OpenAPI document](https://skmtc.dev/scrunchai/apis/scrunch-data-api/revisions/de4fc679600a?raw)
