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

# Delete an onboarding

> Deletes an unclaimed trial: the agent, its workspace, and the trial's key, which stops working. For when the person does not want the agent or the setup went wrong. Deleting one already deleted or expired answers it as it is.



## OpenAPI

````yaml /api-reference/openapi.json delete /onboarding/{onboarding_id}
openapi: 3.1.0
info:
  title: Wiredesk API
  version: 1.0.0
  description: >-
    Read and change a Wiredesk workspace: agents, conversations, contacts, leads
    and knowledge, and talk to an agent. Authenticate with an API key from
    Developers → API keys. Every response carries an x-request-id header, which
    Developers → Logs finds the request by.
servers:
  - url: https://wiredesk.ai/api/v1
security:
  - bearerAuth: []
tags:
  - name: Agents
    description: 'The workspace''s agents: their name, greeting, instructions and channels.'
  - name: Chat
    description: >-
      Send a customer's message to an agent and get its reply, without the chat
      widget.
  - name: Knowledge
    description: >-
      What an agent answers from: pasted text and websites, and the sources
      added in the dashboard.
  - name: Conversations
    description: Conversations on every channel, and their transcripts.
  - name: Contacts
    description: The people the agents talk to, by phone number, email or your own id.
  - name: Leads
    description: Leads the agents captured.
  - name: Onboarding
    description: >-
      Agent-first onboarding: an AI agent builds a trial agent from a website,
      and a person claims it.
paths:
  /onboarding/{onboarding_id}:
    delete:
      tags:
        - Onboarding
      summary: Delete an onboarding
      description: >-
        Deletes an unclaimed trial: the agent, its workspace, and the trial's
        key, which stops working. For when the person does not want the agent or
        the setup went wrong. Deleting one already deleted or expired answers it
        as it is.
      operationId: delete_onboarding
      parameters:
        - name: onboarding_id
          in: path
          required: true
          schema:
            type: string
            pattern: ^ob_[0-9a-f]{32}$
          description: The onboarding's id, `ob_` and 32 hex characters.
      responses:
        '200':
          description: The onboarding, deleted
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    $ref: '#/components/schemas/Onboarding'
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
        '403':
          description: Read-only key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
        '409':
          description: Already claimed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
        '429':
          description: Rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
components:
  schemas:
    Onboarding:
      type: object
      description: >-
        An agent-first onboarding: a trial agent built from a website before
        anyone had an account, and where it went.
      properties:
        id:
          type: string
          description: '`ob_` and 32 hex characters.'
        object:
          type: string
          const: onboarding
        status:
          type: string
          enum:
            - active
            - claimed
            - deleted
            - expired
          description: >-
            `active` until someone claims it, it is deleted, or its week runs
            out.
        agent_id:
          type:
            - string
            - 'null'
          description: >-
            The trial's agent; once claimed, the agent in the claimer's
            workspace.
        website_url:
          type: string
        setup_agent:
          type:
            - string
            - 'null'
          description: The `agent_name` it was started with.
        claim_url:
          type: string
          format: uri
          description: >-
            The one link for the person: they chat with the agent there, and
            claim it.
        claim:
          type: object
          properties:
            email:
              type:
                - string
                - 'null'
              description: Prefilled on the sign-up form.
            plan:
              type: string
              const: free
              description: A claimed agent is always on the Free plan.
            claimed_at:
              type:
                - string
                - 'null'
              format: date-time
        created_at:
          type: string
          format: date-time
        expires_at:
          type: string
          format: date-time
          description: Unclaimed by then, the trial is deleted.
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              enum:
                - invalid_request
                - unauthorized
                - spend_cap_reached
                - read_only_key
                - channel_disabled
                - knowledge_full
                - not_found
                - method_not_allowed
                - already_exists
                - conflict
                - rate_limited
                - internal_error
                - upstream_error
                - not_configured
            message:
              type: string
          additionalProperties: true
  headers:
    RequestId:
      description: >-
        A unique id for this request, on every response including errors.
        Developers → Logs finds the request by it; quote it to support.
      schema:
        type: string
        format: uuid
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An API key, `wd_...`.

````

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