Create docs draft

Propose an article change for review. kind: edit edits an existing article, kind: create proposes a new article, kind: delete proposes removal.

POST /docs/drafts

Create docs draft

cURL

curl --request POST \
  --url https://productlane.com/api/v2/docs/drafts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "article_id": "<string>",
  "title": "<string>",
  "content": "<string>",
  "group_id": "<string>",
  "submit_for_review": true
}
'

200

{
  "id": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "article_id": "<string>",
  "group_id": "<string>",
  "portal_instance_id": "<string>",
  "content": "<string>",
  "title": "<string>",
  "created_by_user_id": "<string>",
  "closed_at": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

kind · enum<string> · required

edit proposes changes to an existing article (requires article_id + content). create proposes a new article (requires title + content). delete proposes removing an existing article (requires article_id).

Available options: edit, create, delete

article_id · string

Required for kind: edit and kind: delete.

title · string

Required for kind: create. Optional for kind: edit (sets a new title; omit to keep the current one). Ignored for kind: delete.

Minimum string length: 1

content · string

Markdown body of the proposed article. Required for kind: edit and kind: create. Ignored for kind: delete.

Minimum string length: 1

group_id · string

kind: create only. Target group for the new article. The group's portal determines which portal the article belongs to once accepted.

submit_for_review · boolean

true (default) creates an OPEN draft visible to reviewers. false keeps it as a private DRAFT.

Response

200

application/json

Successful response

id · string · required

created_at · string · required

updated_at · string · required

kind · enum<string> · required

Available options: edit, create, delete

status · enum<string> · required

Available options: draft, open, accepted, rejected, superseded

article_id · string | null · required

group_id · string | null · required

portal_instance_id · string | null · required

content · string · required

title · string | null · required

created_by_user_id · string | null · required

closed_at · string | null · required