> ## Documentation Index > Fetch the complete documentation index at: https://docs.skyfree.io/llms.txt > Use this file to discover all available pages before exploring further. # Update roadmap item > Update the status and/or release version, date and notes of an existing roadmap item (it never creates one). The roadmap is global to the instance, so the key needs instance access. Fires the roadmap webhook and emails the submitter as the platform they submitted on. A request that changes nothing sends neither. Optional source is echoed in the webhook so the caller can ignore its own change. Release fields are only accepted when the status is released. Authentication: API key via X-API-Key header (or Authorization: Bearer). Permissions: User API key with instance access Rate limit: api_admin_write — 20 requests/min per API user. ## OpenAPI ````yaml /api-reference/platform.openapi.json post /api/platform/v1/roadmap/update openapi: 3.1.0 info: title: Platform API version: 1.0.0 description: >- Manage platform users, subscriptions, add-ons, and support tickets across your platform. These endpoints require platform-level access on the account that owns the API key. Generate your API key in the Developer Portal (profile menu → Developer) and send it in the `X-API-Key` header, or as `Authorization: Bearer `. Never put the key in the URL. Every endpoint accepts POST with a JSON body, and also accepts GET with the same parameters as query-string values. All responses use the envelope `{ success, data?, message?, error? }`. servers: - url: https://YOUR_DOMAIN description: Your deployment, for example https://app.example.com security: [] tags: - name: Platform description: Platform API — Platform - name: Users description: Platform API — Users - name: Subscriptions description: Platform API — Subscriptions - name: Add-ons description: Platform API — Add-ons - name: Tickets description: Platform API — Tickets - name: Roadmap description: Platform API — Roadmap paths: /api/platform/v1/roadmap/update: post: tags: - Roadmap summary: Update roadmap item description: >- Update the status and/or release version, date and notes of an existing roadmap item (it never creates one). The roadmap is global to the instance, so the key needs instance access. Fires the roadmap webhook and emails the submitter as the platform they submitted on. A request that changes nothing sends neither. Optional source is echoed in the webhook so the caller can ignore its own change. Release fields are only accepted when the status is released. Authentication: API key via X-API-Key header (or Authorization: Bearer). Permissions: User API key with instance access Rate limit: api_admin_write — 20 requests/min per API user. parameters: - name: id in: query required: false description: Roadmap item id. schema: type: string example: YOUR_ID - name: status in: query required: false description: exploring | planned | in_progress | beta | released. schema: type: string example: YOUR_STATUS - name: releaseVersion in: query required: false description: For example v2.4.0. Only with status released. schema: type: string example: YOUR_RELEASEVERSION - name: releaseDate in: query required: false description: ISO date, for example 2026-10-15. Only with status released. schema: type: string example: YOUR_RELEASEDATE - name: releaseNotes in: query required: false description: Release notes. Only with status released. schema: type: string example: YOUR_RELEASENOTES - name: source in: query required: false description: >- Who is calling (a-z, 0-9, - and _, up to 32). Echoed as data.source in the webhook; defaults to api. schema: type: string example: YOUR_SOURCE requestBody: required: true content: application/json: schema: type: object required: - id properties: id: type: string description: Roadmap item id. example: YOUR_ID status: type: string description: exploring | planned | in_progress | beta | released. example: YOUR_STATUS releaseVersion: type: string description: For example v2.4.0. Only with status released. example: YOUR_RELEASEVERSION releaseDate: type: string description: ISO date, for example 2026-10-15. Only with status released. example: YOUR_RELEASEDATE releaseNotes: type: string description: Release notes. Only with status released. example: YOUR_RELEASENOTES source: type: string description: >- Who is calling (a-z, 0-9, - and _, up to 32). Echoed as data.source in the webhook; defaults to api. example: YOUR_SOURCE example: id: 550e8400-e29b-41d4-a716-446655440000 status: released releaseVersion: v2.4.0 releaseDate: '2026-10-15' source: plane responses: '200': description: 'Success. Envelope: { success:true, data, message? }.' content: application/json: schema: type: object required: - success properties: success: type: boolean example: true data: {} message: type: string pagination: type: object total: type: number example: success: true message: Roadmap item updated data: id: 550e8400-e29b-41d4-a716-446655440000 status: released releaseVersion: v2.4.0 releaseDate: '2026-10-15T00:00:00.000Z' releaseNotes: null changed: true '400': description: >- Missing/invalid parameters. Body has success:false plus error and message. content: application/json: schema: type: object required: - success - error properties: success: type: boolean example: false error: type: string message: type: string '401': description: >- Missing or invalid API key (or session expired for session endpoints). content: application/json: schema: type: object required: - success - error properties: success: type: boolean example: false error: type: string message: type: string '403': description: >- Authenticated but not authorized — wrong permissions or cross-tenant resource. content: application/json: schema: type: object required: - success - error properties: success: type: boolean example: false error: type: string message: type: string '404': description: Roadmap item not found. content: application/json: schema: type: object required: - success - error properties: success: type: boolean example: false error: type: string message: type: string '429': description: >- Rate limited. Retry after the Retry-After seconds; see RateLimit-* headers. content: application/json: schema: type: object required: - success - error properties: success: type: boolean example: false error: type: string message: type: string '500': description: >- Unexpected server error. Body has success:false plus error and message. content: application/json: schema: type: object required: - success - error properties: success: type: boolean example: false error: type: string message: type: string security: - apiKeyHeader: [] - bearerAuth: [] components: securitySchemes: apiKeyHeader: type: apiKey in: header name: X-API-Key description: Preferred. API key value directly. bearerAuth: type: http scheme: bearer description: Alternative. API key as the bearer token. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.