Skip to main content
POST
Unpublish

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

brand_id
integer
required

The unique identifier for the brand that owns the site.

site_id
string
required

The ULID of the registered site whose Agent Pages you are unpublishing.

Body

application/json
paths
string[]
required

Site-relative paths to unpublish, e.g. /pricing. 1 to 100 entries, each up to 2,048 characters. Full or protocol-relative URLs are rejected. Paths are trimmed and normalized (lowercased, trailing slash and query string dropped), and duplicates after normalization are merged. / is the homepage.

Required array length: 1 - 100 elements
immediate
boolean
default:false

Delete the edge copies before responding, instead of within minutes. Every path whose copy was still at the edge then reports edge, whatever its outcome, so a retry also cleans up a copy an earlier call left behind. A CDN cache in front of your site can still serve a copy it already holds until that copy expires.

Response

One outcome per requested path, in request order, plus the brand's remaining unpublish quota.

results
AgentPagesUnpublishResult · object[]
required

One entry per requested path, in request order (after duplicates are merged).

quota
AgentPagesUnpublishQuotas · object
required

The brand's remaining unpublish quota.