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

# Archive a workspace attribute

> Archives the attribute. Kai keeps every value that contacts already
hold for it, and refuses new writes to it.

Send `restore=true` to make the attribute writable again.




## OpenAPI

````yaml /openapi.yaml delete /attributes/{key}
openapi: 3.1.0
info:
  title: Kai Contacts API
  version: 1.0.0
  description: |
    Push, update, assign and export the contacts of one Kai workspace.

    Every request needs an API key. Make a key in Kai, under
    **Settings → API**. Send the key in the `Authorization` header.

    The API works on one workspace. The key decides which workspace, so no
    request carries a workspace id.
  contact:
    name: Kai support
    url: https://kaisupport.com
servers:
  - url: https://kaisupport.com/api/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Contacts
    description: Customer profiles, their attributes and their account owners.
  - name: Attributes
    description: The attributes that the workspace keeps on every contact.
  - name: Members
    description: The teammates of the workspace. Read-only.
paths:
  /attributes/{key}:
    parameters:
      - name: key
        in: path
        required: true
        description: The API name of the attribute.
        schema:
          type: string
    delete:
      tags:
        - Attributes
      summary: Archive a workspace attribute
      description: |
        Archives the attribute. Kai keeps every value that contacts already
        hold for it, and refuses new writes to it.

        Send `restore=true` to make the attribute writable again.
      operationId: archiveAttribute
      parameters:
        - name: restore
          in: query
          description: Set to `true` to restore an archived attribute.
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: The archived attribute.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AttributeEnvelope'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    AttributeEnvelope:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Attribute'
    Attribute:
      type: object
      properties:
        key:
          type: string
          description: >-
            The API name. It starts with a letter and holds lowercase letters,
            digits and underscores.
        label:
          type: string
        description:
          type:
            - string
            - 'null'
        type:
          type: string
          enum:
            - text
            - number
            - boolean
            - date
            - select
            - url
            - email
            - phone
        options:
          type: array
          items:
            type: string
          description: >-
            The allowed values of a `select` attribute. Empty for the other
            types.
        position:
          type: integer
        archived:
          type: boolean
    Error:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
    ErrorBody:
      type: object
      properties:
        type:
          type: string
          description: A stable machine name for the error.
        message:
          type: string
          description: One sentence for a human reader.
        details:
          description: The attributes or the identities that caused the error.
  responses:
    Unauthorized:
      description: The API key is missing or not valid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: unauthorized
              message: That API key is not valid.
    Forbidden:
      description: The API key does not have the permission that this endpoint needs.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: forbidden
              message: This key does not have the "contacts:write" permission.
    NotFound:
      description: There is no such record in this workspace.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: not_found
              message: No such contact.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        Send your API key as `Authorization: Bearer kai_live_...`.

        Make and revoke keys in Kai, under **Settings → API**. Kai stores only
        a hash of the key, so the full key is shown one time.

````