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

# Set short link status

> **Required permission:** `biolinks:links:publish`



## OpenAPI

````yaml /api-reference/biolinks.openapi.json put /links/{link}/status
openapi: 3.1.0
info:
  title: Link in Bio API
  version: 1.0.0
  description: >-
    Link-in-bio pages and their blocks, short links, QR codes, tracking pixels,
    form submissions, analytics and custom domains.
servers:
  - url: https://{domain}/api/v1/biolinks
    description: Your platform domain
    variables:
      domain:
        default: app.example.com
        description: The domain you sign in to, without https://
security:
  - bearerAuth: []
  - apiKeyHeader: []
tags:
  - name: Pages
  - name: Blocks
  - name: Short links
  - name: Catalogue
  - name: Analytics
  - name: Submissions
  - name: QR codes
  - name: Pixels
  - name: Domains
paths:
  /links/{link}/status:
    put:
      tags:
        - Short links
      summary: Set short link status
      description: '**Required permission:** `biolinks:links:publish`'
      operationId: links.status
      parameters:
        - name: link
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Link ID.
        - name: If-Match
          in: header
          required: true
          schema:
            type: string
            example: '"a1b2c3"'
          description: >-
            The current `revision` in quotes, from the resource's `ETag`.
            Missing returns `428`; out of date returns `412`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - status
              properties:
                status:
                  type: string
                  enum:
                    - active
                    - paused
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Link'
components:
  schemas:
    Link:
      type: object
      properties:
        revision:
          type: string
        id:
          type: string
          format: uuid
        slug:
          type: string
        domain:
          type: string
          format: uuid
          nullable: true
        public_url:
          type: string
        title:
          type: string
          nullable: true
        destination:
          type: string
        status:
          type: string
          enum:
            - active
            - paused
        disabled:
          type: boolean
        has_password:
          type: boolean
        settings:
          type: object
          description: '`utm`, `forward_query`, `http_status`, `sensitive_content`.'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'A workspace API key: `Authorization: Bearer osk_...`'
    apiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: The same workspace API key in the `x-api-key` header.

````

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