Append Content

Adds text at the specified location on a page. Specify exactly one field: body, section,
or anchor.

If you provide revision, the service checks the page version. A mismatch causes an update
conflict.

If the anchor is not found and anchor.fallback=true, the text is added to the end of the page. Otherwise,
an error is returned because the anchor was not found.

For common headers and authentication methods, see Access to the API. For sample scenarios, see API usage examples.

Request

POST

https://api.wiki.yandex.net/v1/pages/{idx}/append-content

Path parameters

Name

Description

idx

Type: integer

Page ID. The value of idx is the same as the id field value in the response to GET /v1/pages?slug=… or POST /v1/pages.

Query parameters

Name

Description

fields

Type: string

Additional response fields, separated by commas, such as content,attributes,last_revision_id. If omitted, only the basic page fields are returned. The response format describes the available additional fields.

Example: ``

is_silent

Type: boolean

Do not notify subscribers about the page update

Default: false

Body

application/json

{
  "revision": "example",
  "content": "example",
  "body": {
    "location": "top"
  },
  "section": {
    "id": 0,
    "location": null
  },
  "anchor": {
    "name": "example",
    "fallback": false,
    "regex": false
  }
}

Name	Description
content	Type: string Text to add to the page Min length: `1` Example: `example`
anchor	All of 1 type PageAppendContentAnchorSchema Type: PageAppendContentAnchorSchema Example `{ "name": "example", "fallback": false, "regex": false }` Insert after an anchor. Specify exactly one field: `body`, `section`, or `anchor`. Example `{ "name": "example", "fallback": false, "regex": false }`
body	All of 1 type PageAppendContentBodySchema Type: PageAppendContentBodySchema Example `{ "location": "top" }` Insert at the beginning or end of the page. Specify exactly one of these fields: `body`, `section`, or `anchor`. Example `{ "location": "top" }`
revision	Type: string The page version on which the change is based. Example: `example`
section	All of 1 type PageAppendContentSectionSchema Type: PageAppendContentSectionSchema Example `{ "id": 0, "location": "top" }` Insert into a page section. Specify exactly one of these fields: `body`, `section`, or `anchor`. Example `{ "id": 0, "location": "top" }`

Location

An enumeration.

Type: string

Enum: top, bottom

PageAppendContentBodySchema

Name

Description

location

All of 1 type

Location

Type: Location

An enumeration.

Enum: top, bottom

Insertion location: top for the beginning of the page, or bottom for the end

Example: top

Example

{
  "location": "top"
}

PageAppendContentSectionSchema

Name

Description

Type: integer

Page section ID

location

All of 1 type

Location

Type: Location

An enumeration.

Enum: top, bottom

Insertion location: top is after the section heading, and bottom is at the end of the section

Example: top

Example

{
  "id": 0,
  "location": "top"
}

PageAppendContentAnchorSchema

Name	Description
name	Type: string The name of the anchor after which to insert the text Example: `example`
fallback	Type: boolean If the anchor is not found, append the text to the end of the page instead of returning an error Default: `false`
regex	Type: boolean Find the anchor in the source text using a regular expression instead of parsing the markup Default: `false`

Example

{
  "name": "example",
  "fallback": false,
  "regex": false
}

Responses

200 OK

Body

application/json

{
  "id": 0,
  "slug": "example",
  "title": "example",
  "page_type": "page",
  "redirect": {
    "page_id": 0,
    "redirect_target": {
      "id": 0,
      "slug": "example",
      "title": "example",
      "page_type": null
    }
  },
  "breadcrumbs": [
    {
      "id": 0,
      "title": "example",
      "slug": "example",
      "page_exists": true
    }
  ],
  "attributes": {
    "created_at": "2025-01-01T00:00:00Z",
    "modified_at": "2025-01-01T00:00:00Z",
    "lang": "example",
    "is_readonly": true,
    "comments_count": 0,
    "entity_links_count": 0,
    "comments_enabled": true,
    "is_collaborative": true,
    "is_draft": true
  },
  "content": "example",
  "access_policy": {
    "access_type": "inherited",
    "inherited_access_type": "all_staff",
    "all_staff_role": "reader",
    "has_external": true,
    "invite": {
      "status": null
    }
  },
  "access_lists": {
    "direct": [
      {
        "id": "example",
        "created_at": "2025-01-01T00:00:00Z",
        "user": null,
        "group": null,
        "role": null,
        "inheritance": null
      }
    ],
    "by_link": [
      null
    ],
    "inherited": [
      null
    ]
  },
  "owner": {
    "user": {
      "id": 0,
      "identity": null,
      "username": "example",
      "display_name": "example",
      "is_dismissed": true,
      "affiliation": "example"
    },
    "group": {
      "id": "example",
      "identity": null,
      "name": "example",
      "type": null,
      "metadata": null,
      "members_count": 0
    }
  }
}

Name	Description
id	Type: integer Page ID. In `/v1/pages/{idx}` methods, the value of `idx` is the value of this field.
page_type	Type: string Page type Enum: `page`, `grid`, `wysiwyg`, `template`
slug	Type: string Page address relative to the Wiki root, such as `team/project`. Use this value as the `slug` parameter when retrieving a page by address. Example: `example`
title	Type: string Page title Example: `example`
access_lists	All of 1 type PageAccessListsSchema Type: PageAccessListsSchema Page access lists Example `{ "direct": [ { "id": "example", "created_at": "2025-01-01T00:00:00Z", "user": { "id": 0, "identity": null, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" }, "group": { "id": "example", "identity": null, "name": "example", "type": null, "metadata": null, "members_count": 0 }, "role": "reader", "inheritance": "inherited" } ], "by_link": [ null ], "inherited": [ null ] }` This field is not returned by default Include `access_lists` in the `?fields=access_lists, ...` list to get it in the response. Page access lists Example `{ "direct": [ { "id": "example", "created_at": "2025-01-01T00:00:00Z", "user": null, "group": null, "role": "reader", "inheritance": "inherited" } ], "by_link": [ null ], "inherited": [ null ] }`
access_policy	All of 1 type PageAccessPolicySchema Type: PageAccessPolicySchema Page access policy Example `{ "access_type": "inherited", "inherited_access_type": "all_staff", "all_staff_role": "reader", "has_external": true, "invite": { "status": 0 } }` This field is not returned by default Include `access_policy` in the `?fields=access_policy, ...` list to get it in the response. Page access settings Example `{ "access_type": "inherited", "inherited_access_type": "all_staff", "all_staff_role": "reader", "has_external": true, "invite": { "status": 0 } }`
attributes	All of 1 type PageAttributesSchema Type: PageAttributesSchema Additional page attributes Example `{ "created_at": "2025-01-01T00:00:00Z", "modified_at": "2025-01-01T00:00:00Z", "lang": "example", "is_readonly": true, "comments_count": 0, "entity_links_count": 0, "comments_enabled": true, "is_collaborative": true, "is_draft": true }` This field is not returned by default Include `attributes` in `?fields=attributes, ...` to return it in the response. Example `{ "created_at": "2025-01-01T00:00:00Z", "modified_at": "2025-01-01T00:00:00Z", "lang": "example", "is_readonly": true, "comments_count": 0, "entity_links_count": 0, "comments_enabled": true, "is_collaborative": true, "is_draft": true }`
breadcrumbs	Type: BreadcrumbSchema[] This field is not returned by default To include it in the response, add `breadcrumbs` to the `?fields=breadcrumbs, ...` list. Example `[ { "id": 0, "title": "example", "slug": "example", "page_exists": true } ]`
content	Type: string This field is not returned by default Include `content` in the `?fields=content, ...` list to return it in the response. Page content as a string. Example: `example`
owner	All of 1 type PageOwnerSchema Type: PageOwnerSchema Page owner Example `{ "user": { "id": 0, "identity": { "uid": "example", "cloud_uid": "example" }, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" }, "group": { "id": "example", "identity": { "src": null, "id": "example" }, "name": "example", "type": "wiki", "metadata": { "url": "example", "externals_count": 0 }, "members_count": 0 } }` This field is not returned by default Include `owner` in the `?fields=owner, ...` list to get it in the response. Page owner Example `{ "user": { "id": 0, "identity": null, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" }, "group": { "id": "example", "identity": null, "name": "example", "type": "wiki", "metadata": {}, "members_count": 0 } }`
redirect	All of 1 type RedirectSchema Type: RedirectSchema Page redirect information Example `{ "page_id": 0, "redirect_target": { "id": 0, "slug": "example", "title": "example", "page_type": "page" } }` This field is not returned by default To include it in the response, add `redirect` to the `?fields=redirect, ...` list. Returns `null` if there is no redirect. Example `{ "page_id": 0, "redirect_target": { "id": 0, "slug": "example", "title": "example", "page_type": "page" } }`

PageType

Page type:

page — regular page
grid — page with a table
wysiwyg — page with a visual editor
template — page template

Type: string

Enum: page, grid, wysiwyg, template

PageDetailsSchema

Brief page information

Name	Description
id	Type: integer Page ID. In `/v1/pages/{idx}` methods, the value of `idx` is the value of this field.
page_type	All of 1 type PageType Type: PageType Page type: `page` — regular page `grid` — page with a table `wysiwyg` — page with a visual editor `template` — page template Enum: `page`, `grid`, `wysiwyg`, `template` Page type Example: `page`
slug	Type: string Page address relative to the Wiki root, such as `team/project`. Use this value as the `slug` parameter when retrieving a page by address. Example: `example`
title	Type: string Page title Example: `example`

Example

{
  "id": 0,
  "slug": "example",
  "title": "example",
  "page_type": "page"
}

RedirectSchema

Page redirect information

Name

Description

page_id

Type: integer

ID of the page that the current page redirects to.

redirect_target

All of 1 type

PageDetailsSchema

Type: PageDetailsSchema

Brief page information

Example

{
  "id": 0,
  "slug": "example",
  "title": "example",
  "page_type": "page"
}

The final page in the redirect chain. For example, in the chain A → B → C → D, this is page D for pages A, B, and C.

Example

{
  "id": 0,
  "slug": "example",
  "title": "example",
  "page_type": "page"
}

Example

{
  "page_id": 0,
  "redirect_target": {
    "id": 0,
    "slug": "example",
    "title": "example",
    "page_type": "page"
  }
}

BreadcrumbSchema

Breadcrumb item (navigation chain)

Name	Description
page_exists	Type: boolean The page exists
slug	Type: string Page address (slug) Example: `example`
title	Type: string Page title Example: `example`
id	Type: integer Page ID (if the page exists)

Example

{
  "id": 0,
  "title": "example",
  "slug": "example",
  "page_exists": true
}

PageAttributesSchema

Additional page attributes

Name	Description
comments_count	Type: integer Number of comments on the page
comments_enabled	Type: boolean Comments are enabled
created_at	Type: string<date-time> Date and time the page was created Example: `2025-01-01T00:00:00Z`
entity_links_count	Type: integer Number of links on the page
is_readonly	Type: boolean The page is read-only
lang	Type: string Page language (for example, `ru`, `en`) Example: `example`
modified_at	Type: string<date-time> Date and time the page was last modified Example: `2025-01-01T00:00:00Z`
is_collaborative	Type: boolean Collaborative editing is enabled
is_draft	Type: boolean The page is a draft

Example

{
  "created_at": "2025-01-01T00:00:00Z",
  "modified_at": "2025-01-01T00:00:00Z",
  "lang": "example",
  "is_readonly": true,
  "comments_count": 0,
  "entity_links_count": 0,
  "comments_enabled": true,
  "is_collaborative": true,
  "is_draft": true
}

PageAccessTypeAPI

Page access type:

inherited: Access is inherited from the parent page.
all_staff: Access for all employees.
custom: Personal access permissions.

Type: string

Enum: inherited, all_staff, custom

AccessTypeInheritedAPI

Inherited access type:

all_staff: Access for all employees.
custom: Personal access permissions.

Type: string

Enum: all_staff, custom

RoleAllStaffAPI

reader: Read.
editor: Edit.
extra_editor: Extended editing.

Type: string

Enum: reader, editor, extra_editor

PageInviteStatus

Invite link status:

0: Deleted.
1: Enabled.
2: Disabled.

Type: integer

Enum: 0, 1, 2

AclPreviewInviteSchema

Information about the invite link for page access

Name

Description

status

All of 1 type

PageInviteStatus

Type: PageInviteStatus

Invite link status:
- 0: Deleted.
- 1: Enabled.
- 2: Disabled.
Enum: 0, 1, 2

Example: 0

Invite link status: 0 means deleted (not returned by the API), 1 means enabled, and 2 means disabled.

Example: 0

Example

{
  "status": 0
}

PageAccessPolicySchema

Page access policy

Name	Description
access_type	All of 1 type PageAccessTypeAPI Type: PageAccessTypeAPI Page access type: `inherited`: Access is inherited from the parent page. `all_staff`: Access for all employees. `custom`: Personal access permissions. Enum: `inherited`, `all_staff`, `custom` Access type Example: `inherited`
all_staff_role	All of 1 type RoleAllStaffAPI Type: RoleAllStaffAPI `reader`: Read. `editor`: Edit. `extra_editor`: Extended editing. Enum: `reader`, `editor`, `extra_editor` Role for "All employees" access Example: `reader`
has_external	Type: boolean Indicates whether the page is accessible to external consultants. If `null`, the status is unknown.
inherited_access_type	All of 1 type AccessTypeInheritedAPI Type: AccessTypeInheritedAPI Inherited access type: `all_staff`: Access for all employees. `custom`: Personal access permissions. Enum: `all_staff`, `custom` Inherited access type Example: `all_staff`
invite	All of 1 type AclPreviewInviteSchema Type: AclPreviewInviteSchema Information about the invite link for page access Example `{ "status": 0 }` Information about the invite link for page access Example `{ "status": 0 }`

Example

{
  "access_type": "inherited",
  "inherited_access_type": "all_staff",
  "all_staff_role": "reader",
  "has_external": true,
  "invite": {
    "status": 0
  }
}

UserIdentity

User identifier

Name

Description

cloud_uid

Type: string

User identifier in the cloud

Example: example

uid

Type: string

Yandex user ID

Example: example

Example

{
  "uid": "example",
  "cloud_uid": "example"
}

UserSchema

User information

Name	Description
affiliation	Type: string User affiliation Example: `example`
display_name	Type: string User display name Example: `example`
id	Type: integer Internal user identifier
is_dismissed	Type: boolean The user is dismissed
username	Type: string User login Example: `example`
identity	All of 1 type UserIdentity Type: UserIdentity User identifier Example `{ "uid": "example", "cloud_uid": "example" }` User identifier in the system Example `{ "uid": "example", "cloud_uid": "example" }`

Example

{
  "id": 0,
  "identity": {
    "uid": "example",
    "cloud_uid": "example"
  },
  "username": "example",
  "display_name": "example",
  "is_dismissed": true,
  "affiliation": "example"
}

ComSource

Source of the group ID:

dir: IAM.
cloud: Yandex Cloud.
com: Local database.
staff: Internal employee directory.

Type: string

Enum: dir, cloud, com, staff

ComIdentitySchema

Group identifier

Name

Description

Type: string

Group identifier in the specified source

Example: example

src

All of 1 type

ComSource

Type: ComSource

Source of the group ID:
- dir: IAM.
- cloud: Yandex Cloud.
- com: Local database.
- staff: Internal employee directory.
Enum: dir, cloud, com, staff

Identifier source

Example: dir

Example

{
  "src": "dir",
  "id": "example"
}

GroupType

Group type:

wiki: Wiki group.
service: Service group.
servicerole: Service role.
group: Regular group.
department: Department.

Type: string

Enum: wiki, service, servicerole, group, department

IntranetGroupMetadata

Group metadata from the internal directory

Name

Description

externals_count

Type: integer

Number of external consultants in the group

url

Type: string

Group URL in the directory

Example: example

Example

{
  "url": "example",
  "externals_count": 0
}

IamGroupMetadata

Group metadata from IAM (Identity and Access Management)

Name

Description

dir_id

Type: string

Directory identifier

Example: example

Example

{
  "dir_id": "example"
}

GroupSchema

Group information

Name	Description
identity	All of 1 type ComIdentitySchema Type: ComIdentitySchema Group identifier Example `{ "src": "dir", "id": "example" }` Group identifier in the system Example `{ "src": "dir", "id": "example" }`
name	Type: string Group name Example: `example`
type	All of 1 type GroupType Type: GroupType Group type: `wiki`: Wiki group. `service`: Service group. `servicerole`: Service role. `group`: Regular group. `department`: Department. Enum: `wiki`, `service`, `servicerole`, `group`, `department` Group type Example: `wiki`
id	Type: string Group ID. Uses dir_id in the external version and staff_id in the internal version. Example: `example`
members_count	Type: integer Number of group members Default: `0`
metadata	Any of 2 types IntranetGroupMetadata Type: IntranetGroupMetadata Group metadata from the internal directory Example `{ "url": "example", "externals_count": 0 }` IamGroupMetadata Type: IamGroupMetadata Group metadata from IAM (Identity and Access Management) Example `{ "dir_id": "example" }` Additional group metadata Example `{ "url": "example", "externals_count": 0 }`

Example

{
  "id": "example",
  "identity": {
    "src": "dir",
    "id": "example"
  },
  "name": "example",
  "type": "wiki",
  "metadata": {
    "url": "example",
    "externals_count": 0
  },
  "members_count": 0
}

RoleAPI

Page access role:

reader: Read.
editor: Edit.
extra_editor: Extended editing.
author: Author (full access).

Type: string

Enum: reader, editor, extra_editor, author

InheritanceAPI

Access inheritance for subpages:

inherited: Subpages inherit the access permission.
not_inherited: Subpages do not inherit the access permission.

Type: string

Enum: inherited, not_inherited

PageAccessItem

Custom page access item

Name	Description
id	Type: string Unique access identifier Example: `example`
role	All of 1 type RoleAPI Type: RoleAPI Page access role: `reader`: Read. `editor`: Edit. `extra_editor`: Extended editing. `author`: Author (full access). Enum: `reader`, `editor`, `extra_editor`, `author` Access role Example: `reader`
created_at	Type: string<date-time> Date and time the access was created Example: `2025-01-01T00:00:00Z`
group	All of 1 type GroupSchema Type: GroupSchema Group information Example `{ "id": "example", "identity": { "src": "dir", "id": "example" }, "name": "example", "type": "wiki", "metadata": { "url": "example", "externals_count": 0 }, "members_count": 0 }` Group granted access (populated if access was granted to a group) Example `{ "id": "example", "identity": { "src": "dir", "id": "example" }, "name": "example", "type": "wiki", "metadata": { "url": "example", "externals_count": 0 }, "members_count": 0 }`
inheritance	All of 1 type InheritanceAPI Type: InheritanceAPI Access inheritance for subpages: `inherited`: Subpages inherit the access permission. `not_inherited`: Subpages do not inherit the access permission. Enum: `inherited`, `not_inherited` Access inheritance setting for subpages Example: `inherited`
user	All of 1 type UserSchema Type: UserSchema User information Example `{ "id": 0, "identity": { "uid": "example", "cloud_uid": "example" }, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" }` User granted access (populated if access was granted to a user) Example `{ "id": 0, "identity": { "uid": "example", "cloud_uid": "example" }, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" }`

Example

{
  "id": "example",
  "created_at": "2025-01-01T00:00:00Z",
  "user": {
    "id": 0,
    "identity": {
      "uid": "example",
      "cloud_uid": "example"
    },
    "username": "example",
    "display_name": "example",
    "is_dismissed": true,
    "affiliation": "example"
  },
  "group": {
    "id": "example",
    "identity": {
      "src": null,
      "id": "example"
    },
    "name": "example",
    "type": "wiki",
    "metadata": {
      "url": "example",
      "externals_count": 0
    },
    "members_count": 0
  },
  "role": "reader",
  "inheritance": "inherited"
}

PageAccessListsSchema

Page access lists

Name	Description
by_link	Type: PageAccessItem[] Access via invite link Example `[ { "id": "example", "created_at": "2025-01-01T00:00:00Z", "user": { "id": 0, "identity": null, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" }, "group": { "id": "example", "identity": null, "name": "example", "type": "wiki", "metadata": {}, "members_count": 0 }, "role": "reader", "inheritance": "inherited" } ]`
direct	Type: PageAccessItem[] Direct custom access to the page Example `[ { "id": "example", "created_at": "2025-01-01T00:00:00Z", "user": { "id": 0, "identity": null, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" }, "group": { "id": "example", "identity": null, "name": "example", "type": "wiki", "metadata": {}, "members_count": 0 }, "role": "reader", "inheritance": "inherited" } ]`
inherited	Type: PageAccessItem[] Access inherited from parent pages Example `[ { "id": "example", "created_at": "2025-01-01T00:00:00Z", "user": { "id": 0, "identity": null, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" }, "group": { "id": "example", "identity": null, "name": "example", "type": "wiki", "metadata": {}, "members_count": 0 }, "role": "reader", "inheritance": "inherited" } ]`

Example

{
  "direct": [
    {
      "id": "example",
      "created_at": "2025-01-01T00:00:00Z",
      "user": {
        "id": 0,
        "identity": null,
        "username": "example",
        "display_name": "example",
        "is_dismissed": true,
        "affiliation": "example"
      },
      "group": {
        "id": "example",
        "identity": null,
        "name": "example",
        "type": null,
        "metadata": null,
        "members_count": 0
      },
      "role": "reader",
      "inheritance": "inherited"
    }
  ],
  "by_link": [
    null
  ],
  "inherited": [
    null
  ]
}

PageOwnerSchema

Page owner

Name

Description

group

All of 1 type

GroupSchema

Type: GroupSchema

Group information

Example

{
  "id": "example",
  "identity": {
    "src": "dir",
    "id": "example"
  },
  "name": "example",
  "type": "wiki",
  "metadata": {
    "url": "example",
    "externals_count": 0
  },
  "members_count": 0
}

Group that owns the page

Example

{
  "id": "example",
  "identity": {
    "src": "dir",
    "id": "example"
  },
  "name": "example",
  "type": "wiki",
  "metadata": {
    "url": "example",
    "externals_count": 0
  },
  "members_count": 0
}

user

All of 1 type

UserSchema

Type: UserSchema

User information

Example

{
  "id": 0,
  "identity": {
    "uid": "example",
    "cloud_uid": "example"
  },
  "username": "example",
  "display_name": "example",
  "is_dismissed": true,
  "affiliation": "example"
}

User who owns the page

Example

{
  "id": 0,
  "identity": {
    "uid": "example",
    "cloud_uid": "example"
  },
  "username": "example",
  "display_name": "example",
  "is_dismissed": true,
  "affiliation": "example"
}

Example

{
  "user": {
    "id": 0,
    "identity": {
      "uid": "example",
      "cloud_uid": "example"
    },
    "username": "example",
    "display_name": "example",
    "is_dismissed": true,
    "affiliation": "example"
  },
  "group": {
    "id": "example",
    "identity": {
      "src": null,
      "id": "example"
    },
    "name": "example",
    "type": "wiki",
    "metadata": {
      "url": "example",
      "externals_count": 0
    },
    "members_count": 0
  }
}

Was the article helpful?

Page Grids

Get Page Descendants