Add an email address for the authenticated user

POST /user/emails

Copy endpoint

https://api.github.com

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

Request Body

application/json

{ emails: string[]; } | string[] | string

Responses

201 application/json

Response

interface Email {
email: string;
primary: boolean;
verified: boolean;
visibility: string | null;
}[]

Redirects

304

Not modified

unknown

Client Errors

401 application/json

Requires authentication

interface BasicError {
message?: string;
documentation_url?: string;
url?: string;
status?: string;
}

403 application/json

Forbidden

interface BasicError {
message?: string;
documentation_url?: string;
url?: string;
status?: string;
}

404 application/json

Resource not found

interface BasicError {
message?: string;
documentation_url?: string;
url?: string;
status?: string;
}

422 application/json

Validation failed, or the endpoint has been spammed.

interface ValidationError {
message: string;
documentation_url: string;
errors?: {
resource?: string;
field?: string;
message?: string;
code: string;
index?: number;
value?: string[] | string | number | null;
}[];
}