> ## Documentation Index
> Fetch the complete documentation index at: https://docs.asobeast.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Choose the goal of this workspace or hide the setup checklist

> Changes the fields given and keeps the rest; an empty body changes nothing. goal is improve_rankings, research_idea, use_with_ai or null to clear it, and it orders the checklist. dismissed true hides the checklist for every member and keeps the time of the first dismissal when sent again; false shows it again. Answers the whole checklist. Answers 400 for an unknown goal or a body that is not these two fields, 402 when no plan is in force and 403 to a read scoped token.



## OpenAPI

````yaml /api-reference/openapi.json patch /workspace/checklist
openapi: 3.0.0
info:
  title: asobeast API
  description: >-
    Self hosted ASO toolkit API.


    A metered instance carries RateLimit-Limit, RateLimit-Remaining and
    RateLimit-Reset on every response, for the tightest limit the request
    touched. A self hosted instance has no request rate limits and sends no such
    header. Limits are per workspace, so minting more tokens does not buy more
    capacity, and they are sized per plan across three classes: read for stored
    data, write for configuration changes and store for the endpoints that reach
    the App Store or Google Play.


    A 429 carries Retry-After and a rateLimit object naming the window that
    closed, or an aiAllowance object when the workspace has spent the AI calls
    its plan includes this month. A 403 with a quota object means a plan
    capacity limit such as apps or tracked keyword markets, which is a different
    problem from a rate limit. A 402 with an entitlement object means the
    workspace needs a plan.


    Positions are 1-based and null means checked but not found within the
    captured depth, never zero. Daily granularity uses UTC dates.
  version: 1.15.0
  contact: {}
servers:
  - url: http://localhost:3000/api/backend
    description: Web origin proxy
  - url: http://localhost:4000
    description: Direct API
security:
  - personalApiToken: []
tags: []
paths:
  /workspace/checklist:
    patch:
      tags:
        - auth
      summary: Choose the goal of this workspace or hide the setup checklist
      description: >-
        Changes the fields given and keeps the rest; an empty body changes
        nothing. goal is improve_rankings, research_idea, use_with_ai or null to
        clear it, and it orders the checklist. dismissed true hides the
        checklist for every member and keeps the time of the first dismissal
        when sent again; false shows it again. Answers the whole checklist.
        Answers 400 for an unknown goal or a body that is not these two fields,
        402 when no plan is in force and 403 to a read scoped token.
      operationId: ChecklistController_update
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWorkspaceChecklistDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
components:
  schemas:
    UpdateWorkspaceChecklistDto:
      type: object
      properties:
        goal:
          nullable: true
          enum:
            - improve_rankings
            - research_idea
            - use_with_ai
          type: string
          example: improve_rankings
        dismissed:
          type: boolean
          example: true
  securitySchemes:
    personalApiToken:
      scheme: bearer
      bearerFormat: asob
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.