Publish sale page
Publishes the seller's sale page with location info and returns the shareable URL. Pass an Idempotency-Key. Re-publishing converges on the same page state, but a retry after a mid-flight failure short-circuits on the slug that already exists, so it will not repair a half-written page; replaying the stored first response is the reliable path. IMPORTANT: publishing requires publish: true. A page that has been unpublished stays offline unless you send it — the response still returns 200 and the URL either way.
Request
- Base URL: https://clearlist.me
- URL: https://clearlist.me/api/pages/publish
- Auth: one of:
- API key in header X-ClearList-API-Key
- OAuth 2 (authorization code, authorization URL https://clearlist.me/oauth/authorize, token URL https://clearlist.me/api/oauth/token, scopes: write)
Headers
Unique client-generated key (1-255 chars from A-Za-z0-9_-:.; a UUID works well), scoped to the seller and the operation. The first successful (2xx) response is stored for 24h; retrying the identical request with the same key replays it instead of re-executing, so network-failure retries never create duplicates. A duplicate that arrives while the first is still running gets 409 idempotency_conflict. The same key with a different body (byte for byte) or a different kind of credential gets 422 idempotency_key_reuse and leaves the original record in place: send a new key. An error the operation itself returns is never stored and releases the key.
Request body
Response
Published.
Changes
No recorded changes to this operation across all 1 revision of this API.