---
search:
  tags:
    - Operations
    - PATCH
seo:
  description: >-
    Pins a card to the top of the library, or unpins it. A new pin goes first.
    Up to 12… Reference for the PATCH /v1/cards/{cardId}/pin endpoint in the
    Teak API.
sidebar:
  label: Pin or unpin a card
  badge: PATCH
title: Pin or unpin a card
type: openapi-operation
---
Pins a card to the top of the library, or unpins it. A new pin goes first. Up to 12 cards can be pinned, and archiving or trashing a card unpins it.

`PATCH /v1/cards/{cardId}/pin`

**Request body** (`application/json`)

- `isPinned` (boolean, required)

Request body example:

```json
{
  "isPinned": true
}
```

**Responses**

- `200` — The card with its new \`isPinned\`. Pinning a pinned card, or unpinning one that isn't, changes nothing
- `400` — PIN\_LIMIT\_REACHED: 12 cards are already pinned; unpin one first
- `404` — Card not found
- `409` — CONFLICT: the card is archived; archived cards can't be pinned

Response example, 200:

```json
{
  "aiSummary": "string",
  "aiTags": [
    "string"
  ],
  "aiTranscript": "string",
  "appUrl": "http://example.com",
  "archive": {
    "bytes": 0,
    "capturedAt": 0,
    "kind": "full"
  },
  "article": {
    "readingMinutes": 0,
    "wordCount": 0
  },
  "compactUrl": "string",
  "content": "string",
  "highlightCount": 0,
  "isDeleted": true,
  "metadataStatus": "string",
  "processingStatus": {},
  "linkPreviewDescription": "string",
  "linkFacts": [
    {
      "label": "string",
      "value": "string"
    }
  ],
  "linkPreviewTitle": "string",
  "linkCategory": "string",
  "linkPrice": {
    "amount": 0,
    "currency": "string"
  },
  "linkFaviconUrl": "string",
  "fileWidth": 0,
  "fileHeight": 0,
  "audioWaveform": {
    "detail": [
      0
    ],
    "grid": [
      0
    ]
  },
  "videoScrub": {
    "frameHeight": 0,
    "frameWidth": 0,
    "frames": 0,
    "url": "string"
  },
  "colors": [
    {
      "hex": "string",
      "name": "string"
    }
  ],
  "createdAt": 0,
  "detailUrl": "string",
  "fileExtension": "string",
  "fileKind": "string",
  "fileLanguage": "string",
  "fileName": "string",
  "filePreview": {},
  "fileSize": 0,
  "fileUrl": "string",
  "id": "string",
  "archivedAt": 0,
  "completedAt": 0,
  "folderIds": [
    "string"
  ],
  "isArchived": true,
  "isFavorited": true,
  "isPinned": true,
  "isHidden": true,
  "linkPreviewImageUrl": "string",
  "linkPreviewMedia": [
    {
      "type": "image",
      "url": "string",
      "contentType": "string",
      "width": 0,
      "height": 0,
      "posterUrl": "string",
      "posterContentType": "string",
      "posterWidth": 0,
      "posterHeight": 0
    }
  ],
  "linkSiteName": "string",
  "linkAuthor": "string",
  "linkPublisher": "string",
  "linkPublishedAt": "string",
  "metadataDescription": "string",
  "metadataTitle": "string",
  "mimeType": "string",
  "notes": "string",
  "placeholderUrl": "string",
  "savedAt": 0,
  "screenshotUrl": "string",
  "sourceTitle": "string",
  "sourceUrl": "string",
  "tags": [
    "string"
  ],
  "thumbnailOverridden": true,
  "thumbnailUrl": "string",
  "type": "string",
  "updatedAt": 0,
  "url": "string",
  "links": [
    {
      "id": "string",
      "missing": true,
      "title": "string",
      "type": "string"
    }
  ],
  "linksTruncated": true,
  "backlinks": [
    {
      "id": "string",
      "missing": true,
      "title": "string",
      "type": "string"
    }
  ],
  "backlinksTruncated": true
}
```
