Builder

Edit a plan: the whole step list in its new order (tick or untick, rename, add, remove), its title, or put it away (dismissed) and bring it back (draft). No model call

patch/builder/sessions/{sessionId}/plans/{planId}

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/builder/sessions/{sessionId}/plans/{planId}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Path parameters

sessionIdstring uuid required
planIdstring uuid required

Request body

titlestring
status'draft' | 'dismissed'

dismissed: put the plan away; draft: bring it back

Response

The plan

idstring uuid required
sessionIdstring uuid required
turnIdstring uuid required

The Plan turn that wrote it

status'draft' | 'building' | 'done' | 'dismissed' required
creditsnumber required

Estimated Build Credits of the ticked steps not built yet

createdAtstring required

ISO-8601 timestamp

updatedAtstring required

ISO-8601 timestamp

Changes

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