ideas

Say your change for a growth idea is live

Say your change for a growth idea is live on the production site: the idea moves to checking, and Frontshelf reads the page within minutes. It is a claim about your work, not a verdict. Call it once the change is live, never for a pull request still waiting for its merge (that is ideas_report_pr). Say what you changed in note. A content gap needs page_url (the new page's address); two pages competing need kept_page. Only Frontshelf marks an idea fixed, when it reads the change on the page; fixed never means more clicks. Pass the version you last read as expected_version. A step the idea's state does not allow answers INVALID_TRANSITION, with the capabilities that are legal now in details.legal_actions.

post/v1/ideas/{idea_id}/report-live

Request

  • Base URL: https://frontshelf.io/api
  • URL: https://frontshelf.io/api/v1/ideas/{idea_id}/report-live
  • Auth: HTTP bearer

Path parameters

idea_idstring required

The idea's id (idea_…), as ideas_list and ideas_get give it.

Request body

expected_versioninteger required

The idea's version as you last read it (ideas_get). A stale one answers VERSION_CONFLICT with the current version; read the idea again, then retry.

notestring

What you changed and where, in one line (kept to 200 characters): your human reads it in your attempt.

page_urlstring

Content gaps only, and required there: the full address of the new page on the site, which Frontshelf reads.

kept_pagestring

Two pages competing only, and required there: the page you kept for the search, one of the competing pages ideas_get lists.

dry_runboolean

true: check the call and say what it would do, without doing it.

confirmboolean

true: go ahead with a change that asks for confirmation.

Response

Say your change for a growth idea is live

summarystring required

The answer in one or two sentences, with the numbers it rests on.

warningsstring[] required

What limits this answer (a cap, a read that was cut short). Empty when nothing does.

Changes

No recorded changes to this operation across all 1 revision of this API.