Publish a document

Publishes an existing document, making it accessible via a public URL. If already published, updates the published version. The document must exist and belong to you.

post/documents/{id}/publish

Request

  • Base URL: https://api.unmarkdown.com/v1
  • URL: https://api.unmarkdown.com/v1/documents/{id}/publish
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Document UUID

Request body

slugstring

Custom URL slug (Pro only)

descriptionstring

SEO description

hide_badgeboolean

Hide Unmarkdown badge (Pro only)

visibility'link' | 'public'

Access level (public is Pro only)

page_width'standard' | 'wide' | 'full'

Response

Document published

idstring uuid
titlestring
published_urlstring uri
published_atstring date-time
template_idstring
word_countinteger
reading_time_minutesinteger

Changes

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