Change your name, or how your writes are authored
const url = 'https://api.pealboard.com/account/me';const options = { method: 'PATCH', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"name":"example","writesAsSelf":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://api.pealboard.com/account/me \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "example", "writesAsSelf": true }'Only the fields sent are changed.
writesAsSelf is the standing choice chooseCredential in github/writes.ts reads: with it on, an issue or a comment made through Pealboard is authored as you in GitHub, with your own token, and carries no attribution block — GitHub already shows your face. With it off, the Pealboard App writes it and the body carries > **Opened by** <name> through Pealboard. and a marker, because no GitHub parameter sets the author of an issue.
It can only be turned on by somebody who has linked GitHub; without a token there is nothing to write as. The address is not editable here: changing it is a sign-in question and goes through /auth.
Access. Requires a signed-in person. No workspace is chosen. A person editing their own name and their own choice about authorship. Readable by every credential, whatever scopes it is narrowed to.
Authorizations
Section titled “Authorizations”Request Body
Section titled “Request Body”object
Needs a linked GitHub account. Refused with a 409 without one.
Examplegenerated
{ "name": "example", "writesAsSelf": true}Responses
Section titled “Responses”The person.
object
A UUID this API issued.
The person’s linked GitHub identity, shared across every workspace they belong to.
object
Examplegenerated
{ "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "email": "hello@example.com", "github": { "login": "example", "userId": 1, "writesAsSelf": true }, "workspaceCount": 1}No valid credentials.
object
object
A stable identifier for the kind of failure. Safe to branch on.
What went wrong, written for a person.
Structured particulars, when there are any.
object
What to do about it, when there is something to do.
Quote this when asking about a specific failure.
Examplegenerated
{ "error": { "code": "example", "message": "example", "detail": { "additionalProperty": "example" }, "remedy": "example", "requestId": "example" }}Authenticated, but not permitted.
object
object
A stable identifier for the kind of failure. Safe to branch on.
What went wrong, written for a person.
Structured particulars, when there are any.
object
What to do about it, when there is something to do.
Quote this when asking about a specific failure.
Examplegenerated
{ "error": { "code": "example", "message": "example", "detail": { "additionalProperty": "example" }, "remedy": "example", "requestId": "example" }}No such resource, or it is not visible to you.
object
object
A stable identifier for the kind of failure. Safe to branch on.
What went wrong, written for a person.
Structured particulars, when there are any.
object
What to do about it, when there is something to do.
Quote this when asking about a specific failure.
Examplegenerated
{ "error": { "code": "example", "message": "example", "detail": { "additionalProperty": "example" }, "remedy": "example", "requestId": "example" }}The request conflicts with the current state.
object
object
A stable identifier for the kind of failure. Safe to branch on.
What went wrong, written for a person.
Structured particulars, when there are any.
object
What to do about it, when there is something to do.
Quote this when asking about a specific failure.
Examplegenerated
{ "error": { "code": "example", "message": "example", "detail": { "additionalProperty": "example" }, "remedy": "example", "requestId": "example" }}The request did not match the expected shape.
object
object
A stable identifier for the kind of failure. Safe to branch on.
What went wrong, written for a person.
Structured particulars, when there are any.
object
What to do about it, when there is something to do.
Quote this when asking about a specific failure.
Examplegenerated
{ "error": { "code": "example", "message": "example", "detail": { "additionalProperty": "example" }, "remedy": "example", "requestId": "example" }}Rate limited. Retry after the interval in the header.
object
object
A stable identifier for the kind of failure. Safe to branch on.
What went wrong, written for a person.
Structured particulars, when there are any.
object
What to do about it, when there is something to do.
Quote this when asking about a specific failure.
Examplegenerated
{ "error": { "code": "example", "message": "example", "detail": { "additionalProperty": "example" }, "remedy": "example", "requestId": "example" }}GitHub or another dependency refused or did not answer. Nothing in the workspace changed.
object
object
A stable identifier for the kind of failure. Safe to branch on.
What went wrong, written for a person.
Structured particulars, when there are any.
object
What to do about it, when there is something to do.
Quote this when asking about a specific failure.
Examplegenerated
{ "error": { "code": "example", "message": "example", "detail": { "additionalProperty": "example" }, "remedy": "example", "requestId": "example" }}