goals

Publish this browser's goal, and hand back the page it produced.

Settling already publishes (#3057), so on a settled goal this hands back the live page, and it stays only while looking-glass still calls it; the route leaves with #3057's closing step. Only a settled goal has a promise to show, so an unsettled one is refused rather than published as a blank. Publishing twice is idempotent on an unchanged promise, and a taken-down goal comes back under a new link.

post/goals/{goal_id}/publish

Request

  • Base URL
    https://api.imperfect.co (the document declares no server; this is the origin it was published from)
  • URL
    https://api.imperfect.co/goals/{goal_id}/publish
  • Auth
    none declared

Path parameters

goal_idstring required

Response

Successful Response

namestring required
linestring nullable
localestring required
kind'destination' | 'practice' required
sportstring nullable
set_atstring date-time required
anchor_kind'event' | 'route' nullable
factorsobject[]
page_expected_untilstring date-time nullable
share_idstring required
slugstring required
target_datestring date required
target_precision'day' | 'month' | 'quarter' | 'season' required

Changes

    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status