markdropDocs
Open Markdrop
PATCH/api/v1/documents/{slug}/slug

Change the address

Gives a document a new address. Its old address keeps working for people who can read it.

Token optionalOr edit secret10 per minute per IP

Guide: Addresses

Code samples and Try it

Path parameters

#
  • slugstringRequired

    The document's address: the part after markdrop.in/.

Headers

#
  • X-Edit-Secretstring

    The document's edit secret (sk_…), for a document published without an account. See Edit key.

Request body

#

application/json, required

  • new_slugstringRequired

    The new address. The old one keeps working as a redirect for people who can read the document. 3–50 characters. Matches ^[a-zA-Z0-9_-]+$.

Responses

#
  • 200OK.
  • 409That address is taken, or reserved.
  • 422The request didn't validate. detail lists each problem, with where it is (loc) and why (msg).
  • 429Too many requests from your IP address. Wait the seconds in Retry-After.
200 response: 35 fields (DocumentResponse)
  • slugstring

    The address: markdrop.in/<slug>.

  • urlstring

    The link to share.

  • folder_patharray of string
  • titlestring | null

    Shown on the page and in link previews.

  • contentstring

    The document's Markdown.

  • created_atstring (date-time)

    ISO 8601, for example 2026-11-30T12:00:00Z.

  • updated_atstring (date-time)

    ISO 8601, for example 2026-11-30T12:00:00Z.

  • expires_atstring (date-time) | null

    ISO 8601, for example 2026-11-30T12:00:00Z.

  • viewsinteger

    Default 0.

  • is_password_protectedboolean

    Default false.

  • is_ownedboolean

    Default false.

  • is_ownerboolean

    Default false.

  • idstring | null
  • refstring | null
  • google_doc_urlstring | null
  • google_doc_staleboolean

    Default false.

  • vscode_syncedboolean

    Default false.

  • encryptedboolean

    Set by clients that encrypt in the browser: content and title are already ciphertext. The server never sees the key. Default false.

  • kindstring

    markdown for a document, artifact for a file. Default "markdown".

  • mimestring | null
  • rendererstring | null
  • type_labelstring | null
  • size_bytesinteger | null
  • original_filenamestring | null
  • artifact_urlstring | null
  • download_urlstring | null
  • poster_urlstring | null
  • mediaobject | null
  • file_versioninteger | null
  • workspace_urlstring | null

    The address on its workspace's own domain, when it has a live one.

  • access_levelstring

    Who can open it: link (anyone with the link), private (only you and the people you share it with) or workspace (members of its workspace). Default "link".

  • workspace_idstring | null
  • canobject | null

    What you may do with it: edit, replace, settings, access, rename, delete, share, move, unshare.

  • read_ticketstring | null
  • access_epochinteger

    Default 0.

Did this page help?