Publish Template

Share a template through its public link and the gallery.

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

Requires an API key with the write scope.

Publishing makes the template's subject and body readable by anyone who has its share link, immediately. It appears in the public gallery list only after FoxReach approves it. Publishing a template again keeps its link, updates the listing and resets approval. Unpublish ends the sharing and invalidates the link.

Each publish is recorded as an audit.template.published event with the key as the actor.

Path Parameters#

template_idstringpathrequired

The template id.

Body Parameters#

shareDescriptionstringbodyrequired

Gallery description, 1 to 1,000 characters.

shareCategorystringbodyrequired

cold_outreach, follow_up, intro or breakup.

Response#

dataobject

Show data

shareSlugstring

The share slug.

shareUrlstring

The public page, https://foxreach.io/gallery/{shareSlug}.

galleryApprovedboolean

Always false right after publishing: the gallery list shows the template once it is approved.

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
`422`	`shareDescription` is empty or over 1,000 characters, or `shareCategory` is not one of the four values

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 POST "https://api.foxreach.io/api/v1/templates/tpl_abc123/publish" \
  -H "X-API-Key: otr_your_key" \
  -H "Content-Type: application/json" \
  -d '{"shareDescription": "A short first touch for founders", "shareCategory": "cold_outreach"}'

Python SDK

from foxreach import FoxReach

client = FoxReach(api_key="otr_your_key")
shared = client.templates.publish("tpl_abc123", share_description="A short first touch for founders", share_category="cold_outreach")

TypeScript SDK

import { FoxReach } from "foxreach";

const client = new FoxReach({ apiKey: "otr_your_key" });
const shared = await client.templates.publish("tpl_abc123", { shareDescription: "A short first touch for founders", shareCategory: "cold_outreach" });

Response

JSON

{
  "data": {"shareSlug": "k3Jx9aQ2mZc", "shareUrl": "https://foxreach.io/gallery/k3Jx9aQ2mZc", "galleryApproved": false}
}

Was this page helpful?

View as MarkdownLast updated November 4, 2026