Clerk.EmailAddress (Clerk SDK v1.0.0)
A user can be associated with one or more email addresses and allows them to be contacted via email.
Summary
Functions
Create a new email address
Delete the email address with the given ID
Returns the details of an email address.
Updates an email address.
Functions
create(params, opts \\ [])
Create a new email address
REQUEST BODY SCHEMA: application/json
user_id
string The ID representing the user
email_address
string The new email address. Must adhere to the RFC 5322 specification for email address format.
verified
boolean or null When created, the email address will be marked as verified.
primary
boolean or null Create this email address as the primary email address for the user. Default: false, unless it is the first email address.
delete(id, opts \\ [])
Delete the email address with the given ID
get(id, opts \\ [])
Returns the details of an email address.
update(id, params, opts \\ [])
Updates an email address.
REQUEST BODY SCHEMA: application/json
verified
boolean or null The email address will be marked as verified.
primary
boolean or null Set this email address as the primary email address for the user.