Skip to content
forgit api docs

Set primary email visibility for the authenticated user

PATCH
/user/email/visibility

Sets the visibility for your primary email addresses.

API method documentation

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
visibility
required

Denotes whether an email is publicly visible.

string
Allowed values: public private
Examples
Exampledefault

Example setting the primary email address to private

{
  "visibility": "private"
}

Responses

Section titled “Responses”

200

Section titled “200”

Response

Media typeapplication/json
Array<object>
Email

Email

object
email
required
string format: email
primary
required
boolean
verified
required
boolean
visibility
required
string
nullable
Examples
Exampledefault
[
  {
    "email": "octocat@github.com",
    "primary": true,
    "verified": true,
    "visibility": "private"
  }
]

304

Section titled “304”

Not modified

401

Section titled “401”

Requires authentication

Media typeapplication/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Examplegenerated
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Examplegenerated
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

404

Section titled “404”

Resource not found

Media typeapplication/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Examplegenerated
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

422

Section titled “422”

Validation failed, or the endpoint has been spammed.

Media typeapplication/json
Validation Error

Validation Error

object
message
required
string
documentation_url
required
string
errors
Array<object>
object
resource
string
field
string
message
string
code
required
string
index
integer
value
One of:
string
nullable
Examplegenerated
{
  "message": "example",
  "documentation_url": "example",
  "errors": [
    {
      "resource": "example",
      "field": "example",
      "message": "example",
      "code": "example",
      "index": 1,
      "value": [
        "example"
      ]
    }
  ]
}