PATCH /documents/{id}

Update document

Requires `content:write`.

Authenticate with Authorization: Bearer obk_live_xxx. See authentication.

Parameters

Name	In	Type	Required	Description
`X-Workspace-Id`	header	string	required	The workspace to scope the request to. Can also be passed as a `workspace_id` query parameter.
`id`	path	string	required

Request body

Send as JSON in the request body.

Field	Type	Required
`title`	string	optional
`content_markdown`	string	optional
`meta_title`	string	optional
`meta_description`	string	optional
`slug`	string	optional
`status`	string	optional

Responses

200 OK

Field	Type	Description
`document`	Document

Example request

curl --request PATCH \
  --url https://app.orchly.ai/api/v1/documents/:id \
  --header 'Authorization: Bearer obk_live_xxx' \
  --header 'X-Workspace-Id: ws_xxx' \
  --header 'Content-Type: application/json' \
  --data '{  }'

const res = await fetch(`https://app.orchly.ai/api/v1/documents/${id}`, {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer obk_live_xxx',
    'X-Workspace-Id': 'ws_xxx',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
const data = await res.json();

import requests

resp = requests.patch(
    "https://app.orchly.ai/api/v1/documents/{id}",
    headers={
        "Authorization": "Bearer obk_live_xxx",
        "X-Workspace-Id": "ws_xxx",
    },
    json={},
)
data = resp.json()

Example response

A 200 response. Dynamic fields are shown as their type.

{
  "document": {
    "id": "string",
    "title": "string",
    "status": "string",
    "slug": "string",
    "meta_title": "string",
    "meta_description": "string",
    "word_count": 0,
    "task_id": "string",
    "created_at": "string",
    "updated_at": "string"
  }
}