GET/api/v1/documents/{slug}/comments/{thread_id}/suggestion

Get a suggested edit

A thread's suggested edit as you see it, with what accepting it would do now: applies, and reason when it wouldn't (stale: the text changed; unappliable: it crosses formatting; locked: someone else is editing, so it would wait for them), the line before and after, and what you may do (can).

Token optional240 per minute per IP

Guide: Suggested edits

Code samples and Try it

Path parameters

#
  • slugstringRequired

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

  • thread_idstringRequired

    Matches ^[0-9a-f]{24}$.

Headers

#
  • X-Read-Passwordstring

    The password of a password-protected document.

  • X-Markdrop-Workspacestring

    A workspace's id: answer only if the document is in that workspace, else 404. Workspace domains send it; you rarely need it.

Responses

#
  • 200OK.
  • 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.
Did this page help?