Sample - GitHub REST API
POST/repos/{owner}/{repo}/issues/{issue_number}/suggestions/{suggestion_id}/approve

Approve an issue suggestion

Approves a pending suggestion on an issue. Applies the proposed change (creating the corresponding timeline event), transitions the suggestion to approved, and dismisses any competing pending suggestions for the same change.

Requires triage access to the repository. Approving a suggestion also requires permission to perform the change it applies (for example, setting the issue type, adding a label or assignee, or closing the issue); this only affects fine-grained access tokens and GitHub Apps whose permissions are narrower than the triage role. This endpoint only supports issues, not pull requests.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

4 parameters
ownerstringrequired
The account owner of the repository. The name is not case sensitive.
repostringrequired
The name of the repository without the `.git` extension. The name is not case sensitive.
issue_numberintegerrequired
The number that identifies the issue.
suggestion_idintegerrequired
The unique identifier of the suggestion.

4 status codes
200Response
idintegerrequired
The unique identifier of the suggestion.
issue_idintegerrequired
The unique identifier of the issue the suggestion applies to.
actionstringrequired
The kind of change proposed.
Allowed:set_typeadd_labeladd_fieldadd_assigneeclose_issue
statestringrequired
The suggestion's lifecycle state.
Allowed:pendingappliedapproveddismissedreplacedinvalidated
target_idintegerrequired
The identifier of the target the change applies to (issue type, label, field, assignee, or duplicate issue), when applicable.
target_valuestringrequired
The proposed value, when applicable. An array for multi-select field suggestions.
rationalestringrequired
The rationale the actor provided for the suggestion.
confidencestringrequired
The actor's confidence level in the suggestion.
Allowed:LOWMEDIUMHIGH
actor_idintegerrequired
The unique identifier of the actor that proposed the suggestion.
issue_event_idintegerrequired
The identifier of the timeline event created when the suggestion was approved, when applicable.
resolved_byintegerrequired
The unique identifier of the user who approved or dismissed the suggestion.
created_atstringrequired
The time the suggestion was created.
updated_atstringrequired
The time the suggestion was last updated.
403Forbidden
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
404Resource not found
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
422Validation failed, or the endpoint has been spammed.
messagestringrequired
documentation_urlstringrequired
errorsarray<object>optional

Error handling

A 403 is returned: Forbidden. A 404 is returned: Resource not found. A 422 is returned: Validation failed, or the endpoint has been spammed.

Was this helpful?