Skip to main content
POST
Submit a request for new or improved documentation.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Body

application/json

Details of the documentation request

Request body for submitting a documentation request

topic
string
required

Short topic / title for the documentation being requested

details
string
required

Detailed description of what should be documented, what is missing, and any context that would help.

Optional slug of an existing documentation page that is related or incomplete

Response

Documentation request accepted

Documentation request submission confirmation

ticketId
string

Support ticket ID created to track this request

status
string

Ticket status (typically "open")

topic
string

The requested topic

createdAt
string

ISO timestamp when the request was created