PATCH/user/email/visibility

Set primary email visibility for the authenticated user

Sets the visibility for your primary email addresses.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 body field
visibilitystringrequired
Denotes whether an email is publicly visible.
Allowed:publicprivate

6 status codes
200Response
emailstringrequired
primarybooleanrequired
verifiedbooleanrequired
visibilitystringrequired
304Not modified
401Requires authentication
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
403Forbidden
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
404Resource not found
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
422Validation failed, or the endpoint has been spammed.
messagestringrequired
documentation_urlstringrequired
errorsarray<object>optional

Error handling

A 401 is returned: Requires authentication. A 403 is returned: Forbidden. A 404 is returned: Resource not found. A 422 is returned: Validation failed, or the endpoint has been spammed.