Suggestions

Create a suggestion

POST https://api.pageloop.ai/v1/suggestions

Submit a documentation update suggestion for review.

Body

articleIdbodystringrequired

Article the suggestion applies to.

bodybodystringrequired

Proposed change, in Markdown.

sourcebodyenum (string)

Where the suggestion originated.

Allowed valuesslackintercomlinearmanual

Response

201application/json

Created suggestion

idstring

Suggestion identifier.

stateenum (string)

Review state.

Allowed valuespendingacceptedrejected

cURL

curl -X POST 'https://api.pageloop.ai/v1/suggestions' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{"articleId": "string", "body": "string", "source": "slack"}'

201

{
  "id": "string",
  "state": "pending"
}