Docs
Landing pages

Take a page down

POSThttps://api.norreach.app/v1/pages/{id}/unpublish

Takes a live page down. Its versions stay; publishing again puts it back. Ads pointing at it lose their landing page — check them in the app. dry_run=true changes nothing.

⚠ pages:publishRole must allow: pages.publishIdempotency-Key requiredSupports dry_runOperation id: unpublish_page
POST/pages/{id}/unpublish
curl -X POST "https://api.norreach.app/v1/pages/{id}/unpublish" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
Take a page down
{
  "object": "publish_result",
  "page_id": "5a6b7c8d-9e0f-4a1b-8c2d-3e4f5a6b7c8d",
  "version_id": null,
  "state": "unpublished",
  "note": "The page is no longer live."
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope pages:publish. API keys and scopes

Path parameters

idstring (uuid)pathrequired

An id (UUID).

Query parameters

dry_runbooleanquery

Run every check and return what would happen, changing nothing.

Headers

Idempotency-Keystringheaderrequired

Any unique string (≤ 255). The same key with the same request returns the first answer for 24 hours.

Response

200application/json— Take a page down

object"publish_result"required
page_idstring (uuid)required

An id (UUID).

version_idstring (uuid) | nullrequired
stateenumrequired
One of:publishedwaiting_for_staffunpublisheddry_run
notestringrequired

Errors

Errors are application/problem+json with a stable code.

StatusCodeMeaning
400bad_requestThe request couldn't be read.
400unknown_fieldThe request has a field this operation doesn't know.
400idempotency_key_requiredThis operation needs an Idempotency-Key header.
401unauthorizedA valid API key is required.
403insufficient_scopeThis API key doesn't have the scope this operation needs.
403feature_not_enabledThe API isn't switched on for this workspace.
403role_forbiddenThe key's creator's role can't do this.
404not_foundThat doesn't exist.
409idempotency_in_progressA request with this Idempotency-Key is still running.
409conflictThat conflicts with the current state.
413too_largeThe request body is too large.
422validation_failedThe request has invalid fields.
422idempotency_mismatchThis Idempotency-Key was used with a different request.
429rate_limitedToo many requests. Slow down and try again.
500server_errorSomething went wrong on our side.
503unavailableThe API isn't available right now. Try again shortly.