Save GitHub bot review configuration
PUT
/api/chat-endpoints/{endpointId}/github/configurationPersonal API keyAgent API keyConsole session
Save GitHub bot review configuration.
Compares the configuration revision and rechecks members, sponsors, repositories, and agent tool governance. Does not change the bot's assigned agent or enable formal reviews implicitly.
Authorization
Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. How keys work.
Path parameters
endpointIdstring (uuid)RequiredThe endpoint's id.
Request body
application/json · required
expectedRevisionintegerRequired
≥ 0configurationobjectRequired
configuration.versionnumberRequired
one of: 1configuration.toolsEnabledbooleanRequired
configuration.responsibleUserIdstringRequired
at least 1 characterconfiguration.memberAccessstringRequired
one of: "all_linked", "selected"configuration.peoplearray<object>Required
configuration.defaultsobjectRequired
configuration.defaults.invocationstringRequired
one of: "mentions_only", "linked_authors", "allowed_authors"configuration.defaults.eventsarray<string>Required
items one of: "opened", "synchronize", "reopened", "ready_for_review", "mention", "comment"configuration.defaults.issueOpenedbooleanOptional
configuration.defaults.issueOpenedInstructionsstringOptional
at most 12000 charactersconfiguration.defaults.reviewDraftsbooleanRequired
configuration.defaults.reviewBotAuthorsbooleanRequired
configuration.defaults.includeAuthorsarray<string>Required
each at most 256 charactersconfiguration.defaults.excludeAuthorsarray<string>Required
each at most 256 charactersconfiguration.defaults.targetBranchesarray<string>Required
each at most 256 charactersconfiguration.defaults.excludedBranchesarray<string>Required
each at most 256 charactersconfiguration.defaults.requiredLabelsarray<string>Required
each at most 256 charactersconfiguration.defaults.excludedLabelsarray<string>Required
each at most 256 charactersconfiguration.defaults.ignoredPathsarray<string>Required
each at most 256 charactersconfiguration.defaults.instructionsstringRequired
at most 24000 charactersconfiguration.defaults.promptsobjectRequired
configuration.defaults.findingCategoriesarray<string>Required
each at most 256 charactersconfiguration.defaults.minimumCommentSeveritystringRequired
one of: "info", "warning", "error"configuration.defaults.publishSummarybooleanRequired
configuration.defaults.publishInlinebooleanRequired
configuration.defaults.allowApprovebooleanRequired
configuration.defaults.allowRequestChangesbooleanRequired
configuration.defaults.ratingThresholdnumber | anyRequired
configuration.repositoriesobject<string, object>Required
Responses
200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).
502GitHub returned an invalid response or unavailable capability
503GitHub is temporarily unavailableA dependency is unavailable; retry with backoff.
Errors return {"error": "..."}, often with a code and details. See errors and limits.