latestOpenAPI 3.0.32026-08-1968196306.2 KB

cf02c9310c0f

integrations

upsertDocumentationPage

Create or update the documentation page identified by docId. Upsert semantics enforce the invariant of one general page per integration and one page per use case. For use case pages the use case must exist.

put/v1/integrations/{integrationId}/documentation/{docId}

Path parameters

integrationIdstring uuid required

The integration ID

docIdstring required

'general' for the integration-wide page, otherwise a use case ID

Request body

titlestring required

contentstring required

Markdown source of the page

Response

Documentation page created or updated successfully

idstring required

'general' for the integration-wide page, otherwise the use case ID

integration_idstring uuid required

scope'integration' | 'use_case' required

Whether the page documents the whole integration or a single use case

use_case_idstring uuid

The linked use case. Only set when scope is use_case.

titlestring required

created_atstring date-time required

created_bystring nullable

User ID that created the page

updated_atstring date-time required

updated_bystring nullable

User ID of the last edit

contentstring required

Markdown source of the page

Example response

{
  "id": "general"
}