ideas

Set a growth idea aside

Set a growth idea aside, with a reason and an expires_at (30 days or 90 days from now, or a date at most 365 days ahead); it comes back on its own then. A dismissal is shown to your human, lifted with ideas_restore, and never counts as done. Use it only when the idea is not worth doing, never to empty the list. Your open attempt on it closes. It asks for confirmation: call it with dry_run: true, then with confirm: true. 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}/dismiss

Request

  • Base URL: https://frontshelf.io/api
  • URL: https://frontshelf.io/api/v1/ideas/{idea_id}/dismiss
  • 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.

reasonstring required

Why the idea is not worth doing, 1 to 200 characters. Your human reads it beside the idea.

expires_atstring date-time required

Required: the dismissal lifts itself at this instant (ISO 8601, in the future): 30 days or 90 days from now, or a date at most 365 days ahead.

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

Set a growth idea aside

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.