PATCH/api/v1/artifacts/{slug}

Update a file's settings

Changes a file's title, password or expiry. Every field is optional. The owner may change all of them; editors may change the title.

API token required30 per minute per IP
Code samples and Try it

Path parameters

#
  • slugstringRequired

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

Request body

#

application/json, required

  • titlestring

    Shown on the page and in link previews. Up to 200 characters.

  • read_passwordstring

    Readers must enter this password before they see the content. Up to 100 characters.

  • remove_passwordboolean

    true removes the password. Default false.

  • expires_in"never" | "1h" | "1d" | "7d" | "30d" | "custom"

    When the document is deleted. custom needs custom_expires_at.

  • custom_expires_atstring (date-time)

    The deletion time, when expires_in is custom. Must be in the future. ISO 8601, for example 2026-11-30T12:00:00Z.

Responses

#
  • 200OK.
  • 401No token, or the token is revoked or mistyped.
  • 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: 20 fields (ArtifactResponse)
  • slugstring
  • urlstring
  • titlestring | null

    Shown on the page and in link previews.

  • kindstring

    Default "artifact".

  • mimestring
  • rendererstring
  • type_labelstring
  • size_bytesinteger
  • original_filenamestring | null
  • artifact_urlstring
  • workspace_urlstring | null
  • download_urlstring
  • poster_urlstring | null
  • mediaobject | null
  • 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_ownerboolean

    Default false.

Did this page help?