Faroe.createUserEmailUpdateRequest()
Mapped to POST /users/[user_id]/email-update-requests.
Creates a new email verification request for a user. This can only be called 3 times in a 15 minute window per user.
Definition
async function createUserEmailUpdateRequest(
userId: string,
email: string
): Promise<$$FaroeEmailUpdateRequest>
Parameters
userId
email
: A valid email address.
Error codes
INVALID_DATA
: Invalid email address.TOO_MANY_REQUESTS
: Exceeded rate limit.NOT_FOUND
: The user does not exist.UNKNOWN_ERROR