Submit agent feedback

Report an API issue or documentation mismatch, including the request id of the call it is about when you have one.

Returns 201 when the feedback is stored, or 200 with already_submitted: true when feedback for the same request_id was already recorded on this account.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

categoryenumRequired

Kind of issue: bug, docs_mismatch, friction, feature_gap, quality_degradation or other.

notestringRequired

What went wrong and what you expected instead. 1 to 4000 characters.

request_idstring or nullOptionalformat: "uuid"

The request_id of the API call the feedback is about, from the X-Request-Id response header or the error body. Feedback is stored once per request id.

urlstring or nullOptional

The page the feedback is about, such as a docs page. http(s) only, up to 2048 characters.

tagslist of strings or nullOptional

Labels for filtering, up to 20, each 1 to 50 characters.

Response

Feedback for this request_id was already recorded.

feedback_idstring

ID of the stored feedback.

already_submittedboolean

True when feedback for this request_id was already recorded; the original feedback_id is returned.

request_idstring or null

Unique ID of this request, also in the X-Request-Id header. Include it when contacting support.

Errors

422

Unprocessable Entity Error