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