COcodepen
Pens

Update a Pen

Only the keys given change; an empty body returns the Pen unchanged. The metadata is saved first and the access change second, so a refused access change leaves the metadata saved.

patch/v2/pens/{id}

Request

  • Base URL
    https://api.codepen.io
  • Auth
    • HTTP bearer
    • or API key in header X-API-Key

Request body

access'Public' | 'Private' | 'Protected' | 'Collaborators'

Public; Private (not listed on the site; anyone with the link can view it); Protected (private and password protected); Collaborators (private and for collaborators only). Anything but Public needs a PRO plan.

descriptionstring
passwordstring

Required when changing to Protected. On a Pen that is already Protected, password alone replaces the password.

tagsstring[]

Replaces the whole list.

templateboolean
titlestring

Response

The Pen.

access'Public' | 'Private' | 'Protected' | 'Collaborators' required

Public; Private (not listed on the site; anyone with the link can view it); Protected (private and password protected); Collaborators (private and for collaborators only). Anything but Public needs a PRO plan.

created_atstring date-time required
descriptionstring required
editor'Classic' | 'V2' required

V2, or Classic for a Pen made in the classic editor, which is read-only through the API.

idstring required

The cpid, or the hashid for a Pen made in the classic editor.

loves_countinteger required
passwordstring nullable required

Write-only, so always null.

popularityinteger required
tagsstring[] required
templateboolean required
titlestring required
updated_atstring date-time required
views_countinteger required

Views as the site shows them, tallied in batches, so it can trail by a few minutes.

Example response

{
  "build": {
    "files": [
      {
        "name": "app.js",
        "path": "/src/app.js"
      }
    ]
  },
  "saved_version": {
    "build": {
      "files": [
        {
          "name": "app.js",
          "path": "/src/app.js"
        }
      ]
    },
    "files": [
      {
        "name": "app.js",
        "path": "/src/app.js"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.