Sample - GitHub REST API
PATCH/repos/{owner}/{repo}/import/authors/{author_id}Deprecated

Map a commit author

Updates the mapped identity for a commit author in a repository. Supply email and/or name to change the author's Git identity before pushing new commits to the repository. This operation is closing down and will be removed on April 12, 2024.

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

3 parameters · 2 body fields
ownerstringrequired
The account owner of the repository; the name is not case sensitive.
repostringrequired
The repository name without the `.git` extension; the name is not case sensitive.
author_idintegerrequired
The integer identifier of the commit author to update.

Optional Git author identity fields to update.

emailstringoptional
The new Git author email.
namestringoptional
The new Git author name.

4 status codes
200Returns the updated author object, including its identifier, remote identity, Git email and name, resource URL, and import URL.
idintegerrequired
remote_idstringrequired
remote_namestringrequired
emailstringrequired
namestringrequired
urlstringrequired
import_urlstringrequired
404Returned when the requested repository or commit author cannot be found.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
422Returned when validation fails or the endpoint has been spammed.
messagestringrequired
documentation_urlstringrequired
errorsarray<object>optional
503Returned when the service is unavailable because it is under maintenance.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional

Error handling

A 404 is returned when the requested resource cannot be found. A 422 is returned when validation fails or the endpoint has been spammed. A 503 is returned when the service is under maintenance; author_id must identify the author to update, and any supplied email or name must be a string.