Sign in
Document

Update document

Update a specific document

put/api/v1/document/space/{space_id}/{id}

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

space_idstring required

Path parameter: SpaceId

idstring required

Path parameter: Id

Request body

metadataobject
namestring
parent_idstring
publicboolean

Example request

{
  "content": [
    {
      "props": {
        "boolean_key": true,
        "number_key": 42,
        "string_key": "string_value"
      }
    }
  ],
  "metadata": {
    "boolean_key": true,
    "number_key": 42,
    "string_key": "string_value"
  }
}

Response

Successful response

idstring
metadataobject
namestring
parent_idstring
slugstring
space_idstring

Example response

{
  "content": [
    {
      "props": {
        "boolean_key": true,
        "number_key": 42,
        "string_key": "string_value"
      }
    }
  ],
  "metadata": {
    "boolean_key": true,
    "number_key": 42,
    "string_key": "string_value"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.