Skip to main content

​
Endpoint

Your unique API endpoint URL is displayed in the API Token Management page under “API Documentation” section.

​
Request Format

​
HTTP Method

POST

​
Headers

Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN

​
Request Body

​
Required Fields

FieldTypeDescription
spaceIdstringThe ID or key of the Confluence space
parentIdstringThe ID of the parent page
pageTitlestringThe title of the page to create/update
contentstringMarkdown content to import

​
Optional Fields

FieldTypeDefaultDescription
overwritebooleanfalseIf true, updates existing page with same title and parent. If false, returns error if page exists

​
Example Request Body

{
  "spaceId": "DOCS",
  "parentId": "123456789",
  "pageTitle": "API Integration Guide",
  "content": "# API Integration\n\nThis guide covers how to integrate with our API.\n\n## Authentication\n\nUse Bearer tokens for authentication.",
  "overwrite": false
}

​
Response Codes

​
Success Responses

Status CodeResponse KeyDescription
201createdPage created successfully
200updatedPage updated successfully (when overwrite is true)
Success Response Body: 
{
  "body": "Success: Page created successfully"
}

​
Error Responses

Status CodeResponse KeyDescriptionSolution
400bad-requestMissing required fields or invalid formatVerify all required fields are present and valid
400already-existsPage with same title exists (when overwrite is false)Set overwrite to true or use different title
401unauthorizedMissing or invalid tokenCheck Authorization header format
402license-expiredLicense inactive when token createdContact admin to renew license
403forbiddenToken expiredCreate a new token
404not-foundParent page or space not foundVerify spaceId and parentId are correct
500internal-errorServer errorRetry request, contact support if persists
Error Response Example: 
{
  "body": "Error: Unauthorized - Missing or invalid authorization header. Please provide a valid Bearer token."
}

​
Finding Space and Page IDs

SpaceId The easiest way to find the correct Space ID and Parent Page ID is through the Markdown Importer app itself:
  1. Open Markdown Importer for Confluence in your Confluence instance
  2. Use the Space selector dropdown - the space ID will be visible when you select a space
  3. Use the Page selector dropdown to choose a parent page - the page ID will be displayed in the selection
This ensures you’re using the exact IDs that the API expects and avoids any confusion with space keys vs. space IDs.