• TOC {:toc}

Management of email addresses via the API requires that you are authenticated through basic auth or OAuth with the user scope.

GET /user/emails

This endpoint is accessible with the user:email scope.

<%= headers 200, :pagination => default_pagination_rels %> <%= json(:user_email) {|e| [e]} %>

{{#enterprise-only}}

{{#warning}}

If your GitHub Enterprise appliance has LDAP Sync enabled and the option to synchronize emails enabled, this API is disabled and will return a 403 response. Users managed in LDAP won't be able to add an email address via the API with these options enabled.

{{/warning}}

{{/enterprise-only}}

POST /user/emails

You can post a single email address or an array of addresses:

<%= json ["octocat@github.com", "support@github.com"] %>

<%= headers 201 %> <%= json [ { "email" => "octocat@github.com", "primary" => false, "verified" => false }, { "email" => "support@github.com", "primary" => false, "verified" => false }, ] %>

{{#enterprise-only}}

{{#warning}}

If your GitHub Enterprise appliance has LDAP Sync enabled and the option to synchronize emails enabled, this API is disabled and will return a 403 response. Users managed in LDAP won't be able to remove an email address via the API with these options enabled.

{{/warning}}

{{/enterprise-only}}

DELETE /user/emails

You can include a single email address or an array of addresses:

<%= json ["octocat@github.com", "support@github.com"] %>

<%= headers 204 %>