Skip to main content

Export Launch Plan

GET 
/api/launch-plan/export

Downloads the launch plan as a file.

Required scope: launch_plan:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

  • format=json (default): the signed cutover bundle used to carry a plan from a staging account to the production account. People are identified by email, steps by their stable key. Top-level keys: schema_version, source_tenant, source_environment, exported_at, profile, target_launch_on, tolerance_days, digest_enabled, members (email, name, roles, watcher, digest_opt_out), steps and custom_steps (key, title, phase, milestone, completion, sort_order, owner_email, size, due_on_override, manual_state, done_at, signed_off {by_email, by_name, at, note}, not_applicable {reason, at, by_email}; custom steps add custom_definition), events (comments, sign-offs and edits with their original created_at) and signature (hex HMAC-SHA256 of the canonical JSON of everything else). Edit the file and the signature no longer verifies.
  • format=xlsx: a spreadsheet for outside implementers. Sheet Implementation Guide has the columns # | Task | SKU Phase | Step # | Owner | Week # | Staging/Prod | Priority | Status | Notes; Go-Live Checklist lists every checkpoint with who signed it off and when (the Signed off at (<timezone>) column is in the account's timezone); Team & Roles lists members, roles, weekly capacity and steps owned.

The response is a file download (Content-Disposition: attachment). 404 when the account has no plan.

Authentication: Requires Bearer token with the launch_plan:read scope. The user needs the launch_plan.view permission.

Request​

Responses​

OK

Response Headers
    Content-Type