PATCH/api/v1/documents/{slug}/properties

Set a page's property values

Sets some of a page's property values, by key. null clears one. For people who can edit the page.

Token optionalOr edit secret120 per minute per IP

Guide: Properties and views

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

  • valuesobjectRequired

    Values by property key. null clears one.

  • base_revinteger

    The page's rev you read. If it changed since, the answer is 409 instead of overwriting it.

Responses

#
  • 200OK.
  • 409The page changed since your base_rev.
  • 422A value doesn't fit its property, or it isn't a page.
  • 423Someone else is editing the page, or it's locked.
  • 429Too many requests from your IP address. Wait the seconds in Retry-After.
Did this page help?