Set primary email visibility for the authenticated user

PATCH

/user/email/visibility

Sets the visibility for your primary email addresses.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://api.github.com/user/email/visibility' \
--header 'Content-Type: application/json' \
--data-raw '{
    "visibility": "private"
}'

Response Example

200 - Example 1

[
    {
        "email": "octocat@github.com",
        "primary": true,
        "verified": true,
        "visibility": "public"
    }
]

Request

Body Params application/json

visibility

enum<string>

required

Denotes whether an email is publicly visible.

Allowed values:

publicprivate

Examples

Responses

🟢200Response

application/json

Body

array of:

string <email>

required

Example:

octocat@github.com

primary

boolean

required

Example:

true

verified

boolean

required

Example:

true

visibility

string | null

required

Example:

public

🔵304304

🟠401401

🟠403403

🟠404404

🟠422422

Modified at 2023-08-15 02:59:30

Block a user

Delete an email address for the authenticated user