Skip to content
Get started

Report a wrong or missing page

An agent or a person reports a docs page that is wrong, out of date or missing with one POST to /docs/feedback, which needs no account.

Terminal window
curl -X POST https://allyhub.com/docs/feedback \
-H "Content-Type: application/json" \
-d '{"page": "/docs/start/your-agent", "helpful": false, "comment": "What the page says, what happened instead, and the AllyHub version."}'
Field Type What it is
page string, required The page’s address on the site, starting with /docs
helpful boolean Whether the page answered the question
comment string, at most 2,000 characters What is wrong or missing, and what the reader expected

The answer is 204 No Content when the report is taken, 400 when the request is not valid. A report holds no account and no personal data: do not put any in comment.

Reports are read to correct pages and to write the ones that are missing. The “Was this page helpful?” question at the end of every docs page sends the same request without a comment.

Was this page helpful?