ドキュメントの追加

POST /api/v2/documents

ドキュメントを追加します。
APIを実行するユーザーは、指定したプロジェクトに参加している必要があります。
参加していないプロジェクトを指定した場合、エラーが返されます。

実行可能な権限

管理者
一般ユーザー

リクエストパラメーター

パラメーター名	型	内容
projectId (必須)	Number	プロジェクトのID。 プロジェクトのIDはプロジェクトの状態一覧の取得から取得できます。
title	String	ドキュメントのタイトル。
content	String	ドキュメントの内容。Markdown形式で記述できます。
emoji	String	ドキュメントタイトル横に表示される絵文字。
parentId	String	親ドキュメントのID。このIDを指定した場合、ドキュメントはツリー上でparentIdのドキュメントの子として作成されます。
addLast	Boolean	trueにした場合、ドキュメントはツリー上の兄弟ドキュメントの中で末尾に作成されます。デフォルトはfalseで先頭に追加されます。

リクエストの例

curl --request POST \
--url "https://{{YOUR-DOMAIN}}/api/v2/documents?apiKey=$API_KEY" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data projectId=1 \
--data title="ドキュメントのタイトル" \
--data content="# 見出し\nドキュメントの内容です。" \
--data emoji="📝" \
--data addLast=true

{{YOUR-DOMAIN}}には、対象のスペースのドメインを記入してください。ドメインは、以下のいずれかです。スペースIDが不明の場合は、スペースIDとは？を参照してください。

• https://[スペースID].backlog.com
• https://[スペースID].backlog.jp
• https://[スペースID].backlogtool.com

レスポンス例

レスポンスボディ

{
    "id": "019b4e27b88b7cc4ae16d72c3de62299",
    "projectId": 1,
    "title": "document title",
    "json": {
        "type": "doc",
        "content": [
            {
                "type": "heading",
                "attrs": {
                    "id": "NmU",
                    "level": 1
                },
                "content": [
                    {
                        "type": "text",
                        "text": "head"
                    }
                ]
            },
            {
                "type": "paragraph",
                "content": [
                    {
                        "type": "text",
                        "text": "hello"
                    }
                ]
            }
        ]
    },
    "plain": "# head \n hello",
    "statusId": 1,
    "emoji": "👍",
    "createdUserId": 2,
    "created": "2025-12-24T02:19:42Z",
    "updatedUserId": 2,
    "updated": "2025-12-24T02:19:42Z"
}