Unpublish Template

Stop sharing a template and invalidate its link.

DELETEhttps://api.foxreach.io/api/v1/templates/{template_id}/publish

Requires an API key with the write scope.

The template stays in your workspace. Its share link stops working and it leaves the gallery. Each unpublish is recorded as an audit.template.unpublished event.

Path Parameters#

template_idstringpathrequired

The template id.

Response#

dataobject

Show data

idstring

The template id.

publishedboolean

Always false.

Errors#

Status	Description
`401`	Missing, invalid, revoked or expired API key
`403`	API key does not have the required scope: `write`
`404`	`Template not found`: the template does not exist in this workspace

Rate Limit#

120 requests per minute, shared by every write call in your workspace. Fixed 60-second window.
Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (unix epoch seconds) and X-RateLimit-Bucket (write).
A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns, see Rate Limiting.

Request

cURL

curl -X DELETE "https://api.foxreach.io/api/v1/templates/tpl_abc123/publish" \
  -H "X-API-Key: otr_your_key"

Python SDK

from foxreach import FoxReach

client = FoxReach(api_key="otr_your_key")
client.templates.unpublish("tpl_abc123")

TypeScript SDK

import { FoxReach } from "foxreach";

const client = new FoxReach({ apiKey: "otr_your_key" });
await client.templates.unpublish("tpl_abc123");

Response

JSON

{
  "data": {"id": "tpl_abc123", "published": false}
}

Was this page helpful?

View as MarkdownLast updated November 4, 2026